内存银行

项目概述

内存银行介绍

内存银行是一种用于管理和维护项目上下文的系统，它通过标准化结构组织信息，使人工智能助手能够轻松访问和更新这些信息。内存银行的核心功能包括：

• 初始化：通过调用 memory-bank-mcp initialize_memory_bank 命令创建新的内存银行。
• 跟踪进度：使用 track_progress 工具记录项目进展。
• 记录决策：通过 log_decision 工具记录重要决策及其背景信息。
• 切换模式：根据需要切换不同的操作模式，如代码模式或问题解决模式。

内存银行的数据流

1. 初始化：人工智能助手连接到内存银行服务器并初始化内存银行。
2. 工具调用：人工智能助手通过内存银行服务器提供的工具读取和写入内存银行文件。
3. 上下文维护：内存银行保持上下文信息，使人工智能能够回忆之前做出的决策和进度。

内存银行结构

内存银行采用标准化结构组织信息：

• 产品背景：包括项目概述、目标、所用技术和架构。
• 当前状态：记录当前项目的状态、正在进行的任务、已知问题及下一步操作。
• 进展历史：按时间顺序记录项目更新和里程碑。
• 决策日志：记录重要决策及其背景、替代方案和后果。
• 系统模式：包含项目的架构模式、代码模式和文档模式。

高级功能

• UMB命令：在会话期间临时更新内存银行文件，但不提交更改。
• 模式检测：根据用户输入自动检测并切换模式。
• 文件迁移工具：用于在不同文件命名约定之间进行迁移。
• 语言标准化：所有内存银行文件均以英语生成，确保一致性。

版本控制

该项目遵循语义化版本控制和约定提交法。版本号规则如下：

• 主要版本号：当有破坏性更改时（如提交消息中标记 BREAKING CHANGE 或 !:）。
• 次要版本号：当添加新功能时（如提交消息中标记 feat: 或 feat(scope):）。
• 补丁版本号：其他所有变更（如错误修复、文档更新等）。

完整的变更历史记录在 CHANGELOG.md 文件中。

使用说明

作为命令行工具

# 初始化内存银行
memory-bank-mcp initialize_memory_bank path=./memory-bank

# 跟踪进度
memory-bank-mcp track_progress action="功能实现" description="实现了功能X"

# 记录决策
memory-bank-mcp log_decision title="API设计" context="..." decision="..."

# 切换模式
memory-bank-mcp switch_mode mode=代码

作为库

import { MemoryBankServer } from "@movibe/memory-bank-mcp";

// 创建一个新的服务器实例
const server = new MemoryBankServer();

// 启动服务器
server.start();

贡献指南

• 代码规范：遵循 项目代码规范。
• 提交指南：请参考 提交规范。

许可证

该项目使用 MIT 许可证，具体内容如下：

MIT License
版权所有 (c) 2024, 作者姓名
允许自由使用、修改和分发此软件，前提是保留版权声明。

内存银行状态系统

状态代码说明

• IDLE：表示服务器处于空闲状态。
• BUSY：表示服务器正在处理请求。
• ERROR：表示服务器遇到错误。

状态查询命令

# 查询当前状态
memory-bank-mcp get_status

其他资源

• 项目文档
• 问题提交

如需进一步了解内存银行，请访问 项目主页。