项目简介

Memory Bank是一套旨在帮助AI助手保留项目上下文的结构化文档系统。本项目是一个遵循 Model Context Protocol (MCP) 的服务器,它提供了一系列工具和上下文信息,帮助用户创建、管理和使用Memory Bank。通过与支持MCP的AI客户端(如某些IDE中的AI助手)集成,本项目能提升AI理解项目背景和提供准确帮助的能力。

主要功能点

  • 获取Memory Bank结构: 提供Memory Bank推荐文件结构的详细描述。
  • 生成文件模板: 根据需要生成特定Memory Bank文件的Markdown模板。
  • 分析项目摘要: 分析用户提供的项目简要说明,并为填充Memory Bank内容提供建议。
  • 提供使用指南: 通过MCP Resource提供Memory Bank的设置和使用方法指导。

安装步骤

本项目需要Python环境。最基本的安装步骤如下:

  1. 克隆本项目的代码仓库。
  2. 在项目目录下,创建一个Python虚拟环境(推荐):
    • 在Linux/macOS上运行:'python3 -m venv venv'
    • 在Windows上运行:'python -m venv venv'
  3. 激活虚拟环境:
    • 在Linux/macOS上运行:'source venv/bin/activate'
    • 在Windows上运行:'venv\Scripts\activate'
  4. 安装项目依赖:确保虚拟环境已激活,运行 'pip install -r requirements.txt'。

服务器配置(为MCP客户端准备)

本MCP服务器需要由您的MCP客户端(如某些AI IDE或工具)来启动和管理。您需要在客户端的MCP配置文件(通常是 'mcp.json' 或类似的JSON文件)中添加一个条目来定义如何连接到此服务器。

配置信息通常需要指定:

  • 服务器名称 (server name): 一个用于标识此服务器的唯一名称(例如:"memory-bank")。
  • 启动命令 (command) 和参数 (args): 如果您选择让客户端通过运行本地命令来启动服务器(如手动安装方式),则需要指定运行服务器的命令(例如 'python')及其参数(例如 '["server.py"]')。
  • URL (url): 如果服务器部署在远程并通过网络(如SSE)提供服务,则需要指定服务器的访问URL。

请根据您选择的运行方式(手动安装后本地运行、Docker、通过Smithery平台运行或连接到公共SSE端点等)查阅相关文档或项目说明,以获取准确的配置命令或URL。例如,如果使用手动安装方式在本地运行,配置大致会包含 'command: "python"' 和 'args: ["server.py"]'。

基本使用方法

一旦您的MCP客户端配置并成功连接了本服务器,您就可以在AI助手中通过自然语言与其交互。

  • 您可以请求AI助手获取Memory Bank的文件结构说明。
  • 您可以要求AI助手生成特定文件的模板,例如请求生成 'projectbrief.md' 的模板。
  • 您可以向AI助手提供项目摘要,并请求它根据摘要为您的Memory Bank内容提供建议。
  • AI助手也可能通过Resource请求本服务器提供的Memory Bank设置或使用指南,以便更好地协助您。

例如,您可以尝试向您的AI助手提出类似的请求:“请使用你的工具为我的待办事项应用创建Memory Bank”或“请生成 projectbrief.md 的Memory Bank模板”。

信息

分类

AI与计算