MCP文档管理工具

一个用于管理多个本地文档项目的MCP（Model Context Protocol）工具，支持在Cursor等AI工具中创建、读取、更新、删除和搜索文档。

功能特性

• 📁 多项目管理：支持管理多个项目的文档
• 📝 分类管理：支持需求文档、设计文档、API文档、开发文档、测试文档、操作日志等分类
• 🔍 全文搜索：支持跨文档内容搜索
• 📋 模板支持：内置多种文档模板
• 🌐 中文支持：支持中文模块名称自动转换为拼音
• 🔧 MCP兼容：完全兼容MCP协议，支持Cursor等AI工具

快速开始

安装

# 使用npx（推荐）
npx -y mcp-document-manager

# 或全局安装
npm install -g mcp-document-manager

在Cursor中配置

在 ~/.cursor/mcp.json 或 %APPDATA%\Cursor\User\globalStorage\cursor.mcp\mcp.json 中添加：

{
  "mcpServers": {
    "docs": {
      "command": "npx",
      "args": ["-y", "mcp-document-manager"],
      "env": {
        "PROJECT_MAPPING_FILE": "C:/path/to/your/project-mapping.json"
      }
    }
  }
}

创建项目映射文件

创建 project-mapping.json 文件：

{
  "D:/project1/docs": {
    "projectName": "project1",
    "workPath": "D:/project1"
  },
  "D:/project2/docs": {
    "projectName": "project2",
    "workPath": "D:/project2"
  }
}

使用方法

配置完成后，重启Cursor，然后可以使用以下命令：

• 请使用docs工具在requirements分类下创建一个名为"user-management"的文档
• 请使用docs工具列出api分类下的所有文档
• 请使用docs工具搜索包含"用户"的文档

支持的文档分类

• requirements: 需求文档
• designs: 设计文档
• api: 接口文档
• develop: 开发文档
• test: 测试文档
• logs: 操作日志

详细配置指南

请查看 NPM_CONFIG_GUIDE.md 获取完整的配置说明，包括：

• npm发布和版本管理
• 各种安装方式的配置
• 故障排除指南
• 最佳实践建议

开发

本地开发

# 克隆项目
git clone https://github.com/yourusername/mcp-document-manager.git

# 安装依赖
npm install

# 开发模式
npm run dev

# 构建
npm run build

发布

# 构建项目
npm run build

# 发布到npm
npm publish

许可证

MIT License

贡献

欢迎提交Issue和Pull Request！

更新日志

v1.0.0

• 初始版本发布
• 支持基本的文档CRUD操作
• 支持多项目管理
• 支持全文搜索
• 支持文档模板