项目记忆服务器

为AI助手提供开发项目的持久记忆功能,实现上下文保存、进度跟踪和决策记录。

  • by engramforge
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 engramforge/project-memory-mcp

使用说明

mcp项目内存

用于Claude桌面的项目内存MCP服务器

🧠 项目内存MCP服务器

为AI助手提供有关您的开发项目的持久记忆

概述

Project Memory MCP Server将AI助手从无状态工具转变为知识渊博的团队成员,他们对您的开发项目有持久的记忆。你的AI助手不会在每次对话中重新解释上下文,而是会记住:

  • 📋 实施进度 -跟踪所有项目组件的完成状态
  • 🏗️ 体系结构决策 -记录技术选择的基本原理和影响
  • 🔧 工作解决方案 -构建一个可搜索的经过验证的修复程序库
  • 🎯 当前优先事项 -维护随项目发展而变化的动态优先级列表
  • 💬 对话历史 -在开发会议中保留上下文
  • 🔍 可搜索知识 -从过去的讨论中查找相关信息

为什么这很重要

项目记忆之前:

  • “记住,我们使用FastAPI作为后端…”
  • “正如我上周提到的,Docker设置需要……”
  • “我们决定使用React,因为…”

项目记忆之后:

  • AI:“根据您的FastAPI后端架构和我们上周解决的Docker问题,以下是如何进行React集成……”

主要特点

🎯 智能上下文加载

每次对话都从完整的项目背景开始,不再有重复的解释。

📊 实施跟踪

通过详细的状态更新和完成跟踪来监控所有组件的进度。

🏗️ 决策考古学

每一个技术决策都记录了其背后的逻辑,创造了一种在团队变动中幸存下来的制度记忆。

🔧 解决方案库

构建一个可搜索的工作解决方案数据库,该数据库会随着您的项目经验而增长。

🔍 智能搜索

使用自然语言查询查找相关的过去决策、解决方案和上下文。

📝 对话连续性

每次讨论都建立在先前的知识之上,创造了越来越有价值的人工智能帮助。

快速开始

选项1:npx快速入门(推荐)

无需安装即可为任何项目运行服务器:

npx project-memory-mcp --project-root /path/to/your/project

选项2:全局安装

全局安装以供重复使用:

npm install -g project-memory-mcp
project-memory-mcp --project-root /path/to/your/project

选项3:开发安装

  1. 克隆存储库:

    git clone https://github.com/yourusername/project-memory-mcp.git
    cd project-memory-mcp/nodejs
    
  2. 安装依赖项:

    npm install
    npm run build
    
  3. 配置Claude桌面: 增添 ~/Library/Application Support/Claude/claude_desktop_config.json:

    {
      "mcpServers": {
        "project-memory": {
          "command": "npx",
          "args": [
            "project-memory-mcp",
            "--project-root", "/path/to/your/project",
            "--verbose"
          ]
        }
      }
    }
    
  4. 重新启动Claude Desktop并开始使用:

    "Load project memory and provide current context"
    

命令行选项

project-memory-mcp [options]

Options:
  -r, --project-root <path>   Root directory of the project (default: current directory)
  -m, --memory-dir <path>     Directory for memory files (default: .project_memory)
  -v, --verbose               Enable verbose logging
  -c, --config <path>         Configuration file path
  -h, --help                  Display help information
  --version                   Show version number

使用示例

开始对话:

"Check project memory and show current status"

录制进度:

"Update frontend status to complete - React app implemented with TypeScript"

记录决策:

"Add decision: Using PostgreSQL for user data because it provides ACID compliance and good JSON support"

寻找解决方案:

"Search memory for Docker networking issues"

结束对话:

"Log this session: Implemented authentication, fixed deployment pipeline, updated to use Redis for caching"

技术架构

存储结构

  • 项目信息:元数据和基本项目信息
  • 实施状态:组件级进度跟踪
  • 体系结构决策:有理由的技术选择
  • 工作解决方案:经过验证的修复和实施
  • 优先级管理:动态优先级跟踪
  • 对话历史:跨届会议的背景保护

存储

  • JSON文件:人类可读的项目内存存储
  • 增量更新:高效更新,无数据丢失
  • 备份和恢复:自动备份内存状态
  • 搜索索引:快速检索相关信息

MCP集成

  • 标准协议:与任何启用MCP的AI助手兼容
  • 基于工具的界面:干净、定义明确的工具功能
  • 错误处理:强大的错误处理和恢复
  • 演出:针对快速上下文加载和TypeScript类型安全进行了优化

可用工具

工具 目的 示例用法
get_project_context 加载完整项目状态 “显示当前项目上下文”
update_implementation_status 跟踪组件进度 “更新API状态以完成”
add_architecture_decision 记录技术决策 “添加决策:使用Redis进行缓存”
add_working_solution 存储经过验证的解决方案 “添加解决方案:Docker内存问题”
update_priorities 管理项目优先级 “更新优先级:1。修复身份验证,2。部署“
search_memory 查找相关信息 “搜索身份验证解决方案”
log_conversation_context 保留会话上下文 “日志:已实现的用户管理”

有关详细的工具文档和使用示例,请参阅 docs/usage.md.

记忆存储

服务器创建 .project_memory 目录包含:

  • project_memory.json -主内存数据库
  • current_context.json -最新项目上下文快照
  • architecture_decisions.json -决策历史
  • working_solutions.json -解决方案数据库
  • conversations.json -对话日志
  • backups/ -自动备份文件

项目类型检测

服务器根据配置文件自动检测项目类型:

  • Node.js/JavaScript: package.json
  • python: requirements.txt, pyproject.toml
  • 锈: Cargo.toml
  • 去: go.mod
  • Java: pom.xml, build.gradle
  • Docker/微服务: docker-compose.yml

项目结构

project-memory-mcp/
├── README.md                   # This file
├── LICENSE                     # MIT License
├── initialize_engramforge.py   # Project initialization script
├── data/                       # Sample data and templates
├── nodejs/                     # Node.js/TypeScript implementation
│   ├── package.json           # Node.js dependencies
│   ├── tsconfig.json          # TypeScript configuration
│   ├── README.md              # Node.js specific documentation
│   ├── src/                   # TypeScript source code
│   │   ├── index.ts           # Main server entry point
│   │   ├── server.ts          # MCP server implementation
│   │   ├── memory-manager.ts  # Memory management logic
│   │   └── types.ts           # TypeScript type definitions
│   └── tests/                 # Test files (to be implemented)
│       ├── memory-manager.test.ts  # Memory management tests
│       ├── server.test.ts     # Server functionality tests
│       └── integration.test.ts # Integration tests
├── docs/                       # Documentation
│   ├── installation.md        # Detailed installation guide
│   └── usage.md              # Comprehensive usage guide
├── examples/
│   ├── claude_desktop_config.json  # Claude Desktop MCP configuration
│   └── project_config.json    # Project memory configuration example

配置

Project Memory MCP服务器可以使用 project_config.json 文件。看 examples/project_config.json 举一个完整的例子。

配置示例

{
  "max_conversation_history": 1000,
  "backup_enabled": true,
  "backup_interval": 3600,
  "compression_enabled": false,
  "auto_detect_project_type": true,
  "search_index_enabled": true,
  "verbose_logging": false
}

配置选项

选项 类型 默认值 描述
max_conversation_history number 100 要保留在内存中的对话条目的最大数量
backup_enabled boolean true 启用项目内存的自动备份
backup_interval number 3600 备份间隔(秒)(3600=1小时)
compression_enabled boolean false 启用内存文件压缩以节省磁盘空间
auto_detect_project_type boolean true 根据文件和结构自动检测项目类型
search_index_enabled boolean true 启用全文搜索索引以实现更快的内存搜索
verbose_logging boolean false 启用调试和开发的详细日志记录

基本配置

{
  "project_root": "/path/to/your/project",
  "memory_file": ".project_memory/memory.json",
  "backup_enabled": true,
  "backup_interval": 3600,
  "max_conversation_history": 100
}

高级配置

{
  "project_root": "/path/to/your/project",
  "memory_file": ".project_memory/memory.json",
  "decisions_file": ".project_memory/decisions.json",
  "solutions_file": ".project_memory/solutions.json",
  "backup_enabled": true,
  "backup_interval": 3600,
  "backup_directory": ".project_memory/backups",
  "max_conversation_history": 1000,
  "search_index_enabled": true,
  "compression_enabled": false,
  "auto_detect_project_type": true,
  "verbose_logging": false
}

用例

🚀 创业发展

  • 跟踪MVP功能实现
  • 记录早期架构决策
  • 为常见问题构建解决方案库
  • 随着市场反馈的发展,维护优先级列表

🏢 企业项目

  • 在团队变革中保护机构知识
  • 记录合规性和安全决策
  • 跟踪多团队协调和依赖关系
  • 维护项目历史记录以供审计

🔬 研究项目

  • 记录实验方法和结果
  • 跟踪文献综述和方法决策
  • 在漫长的时间线上保护研究背景
  • 记录假设演变和检验

🎓 教育项目

  • 跟踪学习进度和掌握的概念
  • 记录解决问题的方法和解决方案
  • 建立知识库以供将来参考
  • 记录项目组合的项目演变

贡献

我们欢迎捐款!请查看我们的 贡献指南 了解详情。

开发设置

  1. 克隆和设置:

    git clone https://github.com/yourusername/project-memory-mcp.git
    cd project-memory-mcp/nodejs
    npm install
    
  2. 构建项目:

    npm run build
    
  3. 开发模式:

    npm run dev
    
  4. 运行测试 (实施时):

    npm test
    npm run test:watch
    npm run test:coverage
    
  5. 代码质量 (当配置了linting时):

    npm run lint
    npm run lint:fix
    npm run type-check
    

路线图

v1.0-核心内存(当前)

  • [x] 基本项目记忆功能
  • [x] MCP服务器实现
  • [x] 决策和解决方案跟踪
  • [x] 会话上下文保存

v1.1-增强搜索

  • []全文搜索功能
  • []语义相似度搜索
  • []高级查询语法
  • []搜索结果排名

v1.2-团队协作

  • []多用户支持
  • []共享项目记忆
  • []基于角色的访问控制
  • []协同决策

v2.0-智能层

  • []决策中的模式识别
  • []自动建议系统
  • []预测性优先级管理
  • []集成见解

支持

隐私与安全

  • 所有数据都存储在本地项目目录中
  • 除了npm包下载外,没有外部网络连接
  • 内存文件是人类可读的JSON格式
  • 添加 .project_memory/ 向 .gitignore 从版本控制中排除

许可证

MIT许可证-请参阅 许可证 文件以获取详细信息。

致谢

  • 内置于 模型上下文协议(MCP)
  • 受开发工作流程中对持久AI内存需求的启发
  • 旨在解决人工智能辅助开发中的上下文丢失问题

使用Project Memory MCP Server将您的AI助手从工具转变为知识渊博的团队成员。