@lucianaib/codemind-mcp

CodeMind MCP

一个 MCP（Model Context Protocol）服务器，旨在通过自动化流程帮助用户快速理解代码仓库。

核心功能

• gitcode_request: 一个通用的 GitCode API 调用工具，可用于管理仓库、拉取请求、问题等。
• repo_clone_and_mindmap: 本项目的核心工具，它会自动执行以下一系列操作：
  • 克隆一个指定的 Git 仓库。
  • 搜集并合并仓库中所有的 Markdown 文档（如 README.md、docs/ 目录下的文件等）到一个 PROJECT_SUMMARY.md 文件中。
  • 调用一个预先配置好的 Coze 工作流，将合并后的文档内容作为输入，生成一个思维导图。
  • 返回包含思维导图公开访问链接的最终结果。

安装与构建

环境要求:

• Node.js >= 18.x
• Git

# 安装依赖
npm install

# 编译 TypeScript
npm run build

# (可选) 本地运行
npm run start

启动成功后，您将在控制台看到类似 CodeMind MCP Server v0.4.1 is running successfully. 的消息。

在 MCP 客户端中使用

推荐配置

在您的 MCP 客户端（如 CodeBuddy）的设置中，添加以下服务器配置，即可通过 npx 自动下载并运行最新版本：

{
  "mcpServers": {
    "CodeMind": {
      "command": "npx",
      "args": ["@lucianaib/codemind-mcp"]
    }
  }
}

工具调用示例

1. gitcode_request

描述: 通用调用 GitCode API。 输入示例:

{
  "name": "gitcode_request",
  "arguments": {
    "token": "Bearer YOUR_GITCODE_TOKEN",
    "method": "GET",
    "path": "/user"
  }
}

2. repo_clone_and_mindmap

描述: 克隆仓库并生成思维导图。 输入示例:

{
  "name": "repo_clone_and_mindmap",
  "arguments": {
    "repoUrl": "https://gitcode.com/owner/repo.git"
  }
}

返回: 包含仓库目录、合并文档路径和最终思维导图 URL 的文本。

Coze 工作流接口说明

• URL: https://api.coze.cn/v1/workflow/run (同步接口)
• 关键返回数据结构:

  {
    "code": 0,
    "data": "{\"output\":\"https://.../mindmap.jpeg\"}"
  }
  

  本项目已内置逻辑来处理这种 data 字段为字符串形式 JSON 的情况。

安全提示

重要: Coze API 的凭证（token, workflow_id, app_id）目前硬编码在 src/mindmap.ts 中。这会暴露敏感信息，请仅在内部或受信任的环境中使用。在生产环境中，强烈建议将这些凭证移至环境变量。

开发与代码结构

• src/index.ts: MCP 服务器入口，使用 McpServer 注册工具。
• src/gitcode.ts: GitCode API 的通用请求封装。
• src/mindmap.ts: 实现仓库克隆、文档合并及调用 Coze API 的核心逻辑。

项目信息

• GitHub: https://github.com/lfrbmw/CodeMind-MCP
• npm Package: @lucianaib/codemind-mcp

许可证

本项目采用 MIT 许可证。详见 LICENSE 文件。