代码文档生成系统

Hive Mind MCP Server 是一个智能代码文档系统,能够实时生成和维护代码库的活文档,支持从现有代码库中逆向生成文档,并包含AI导航和自动生成图表功能。

  • by Jahanzaib-Kaleem
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 Jahanzaib-Kaleem/hive-mind-mcp

使用说明

Hive Mind MCP服务器

用于代码库的智能文档系统,在您构建时创建实时文档。

Hive Mind是一个MCP(模型上下文协议)服务器,可以自动生成 hivemind.md 和 hivemind.mmd 在每个目录级别,创建一个可导航的文档蜘蛛网,该蜘蛛网:

  • 作品 实时的 随着代码的构建
  • 能 追溯地 记录现有代码库
  • 保留 用户需求 以及架构决策
  • 启用 智能导航 通过锚点
  • 适用于任何上下文窗口大小(8k到200k令牌)
  • 包含 自动上下文 (为您读取文件预览)
  • 痕迹 外部依赖项 (例如。, react, aws-sdk)
  • 生成 SVG图表 自动地

安装

快速入门(推荐)

您可以直接使用以下命令运行服务器 uvx (无需安装):

{
  "mcpServers": {
    "hive-mind": {
      "command": "uvx",
      "args": ["mcp-hivemind-server"]
    }
  }
}

通过pip安装

pip install mcp-hivemind-server

从源代码安装(开发)

# Clone the repository
git clone https://github.com/Jahanzaib-Kaleem/hive-mind-mcp.git
cd hive-mind-mcp

# Create virtual environment
python -m venv venv
venv\Scripts\activate  # Windows
# source venv/bin/activate  # macOS/Linux

# Install dependencies
pip install -r requirements.txt

需求

  • Python 3.11或更高版本
  • 依赖关系: mcp, tree-sitter, tree-sitter-languages, aiofiles, pyyaml
  • 可选: @mermaid-js/mermaid-cli (用于SVG生成)

配置

适用于反重力/克劳德桌面

编辑MCP配置文件:

视窗: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Linux: ~/.config/claude/claude_desktop_config.json

选项1:使用 uvx (最简单)

{
  "mcpServers": {
    "hive-mind": {
      "command": "uvx",
      "args": ["mcp-hivemind-server"]
    }
  }
}

选项2:使用pip安装

{
  "mcpServers": {
    "hive-mind": {
      "command": "hive-mind",
      "args": []
    }
  }
}

选项3:使用源代码

{
  "mcpServers": {
    "hive-mind": {
      "command": "python",
      "args": ["C:/path/to/hive-mind-mcp/server.py"]
    }
  }
}

对于光标

  1. 打开光标设置
  2. 导航到 特性→ MCP服务器
  3. 添加新服务器:
    • 名字: hive-mind
    • 类型: stdio
    • 命令: uvx
    • 参数: mcp-hivemind-server

用法

实时文档

编码时,问你的AI助手:

“在构建此代码时记录它”

AI将呼叫 document_current_work 捕捉:

  • 代码结构(函数、导入、导出)
  • 用户要求和限制
  • 警告和陷阱
  • 下一步和TODO
  • 代码是如何工作的

追溯性文档

对于现有的代码库,请询问:

“用hive思维记录我的整个代码库”

AI将呼叫 build_hive 致:

  • 遍历整个目录树
  • 解析所有代码文件
  • 在每个级别生成文档
  • 创建连接图

引导式蜂巢构建(推荐)

对于 AI丰富 您提供上下文的文档:

“在我的代码库上启动引导式蜂巢构建”

它是如何工作的:

  1. MCP发现所有目录
  2. 对于每个目录,MCP都会显示其结构(文件、函数)
  3. 你阅读了实际的代码 并了解它的作用
  4. 你打电话 continue_hive_build 听你解释
  5. MCP写入 hivemind.md 结合结构和上下文
  6. 重复此操作,直到所有目录都记录在案

新增:自动上下文预览 这 start_hive_build 该工具现在会自动包含目录中每个文件的前100行,因此您不必手动调用 view_file 了解要记录什么。这使过程加快了3倍。

这将创建包含以下内容的文档 来自AI的智能上下文 (你!),而不仅仅是枯燥的解析。

导航

让AI导航你的代码库:

“显示身份验证系统上下文”
“查找validateSession函数”
“跟踪数据库模块的使用情况”

工具

核心工具

工具 说明
document_current_work 构建代码时的实时文档
build_hive 自动记录整个代码库(仅限结构)
navigate_to 从锚点加载上下文
find_function 跨代码库搜索函数
trace_usage 查找依赖项和依赖项(支持外部库 include_external: true)
update_hivemind 代码更改时更新文档
render_hive_svg 从编辑后手动重新渲染SVG .mmd 文件

引导式构建工具

工具 说明
start_hive_build 开始引导构建,返回第一个目录供您记录
continue_hive_build 提交您的上下文,获取下一个目录
get_hive_status 检查引导构建的进度

生成的文件

hivemind.md

每个目录都有一个 hivemind.md 文件包含:

AI上下文部分 (线上):

  • 这是什么-目的和作用
  • 用户需求-约束和偏好
  • 重要提示-警告和陷阱
  • 下一步-TODO和计划工作
  • 工作原理-关键模式和逻辑

干式逻辑部分 (线下):

  • 此级别的文件
  • 已定义的功能
  • 依赖项
  • 出口
  • 连接
  • 导航
  • 指标

hivemind.mmd和hivemind.svg

美人鱼图(和生成的SVG)显示:

  • 当前目录(紫色中心节点)
  • 父目录(灰色)
  • 子目录(绿色)
  • 上游依赖关系(橙色)
  • 下游家属(青色)

锚点

使用锚点导航,格式如下: anchor://path/to/directory

例子:

anchor://project/src/components/auth

测试

# Run all tests
python -m pytest tests/ -v

# Run specific test file
python -m pytest tests/test_parser.py -v

# Run with coverage
python -m pytest tests/ --cov=. --cov-report=html

项目结构

hive-mind-mcp/
├── server.py              # Main MCP server entry point
├── parser.py              # Code structure extraction (tree-sitter)
├── generator.py           # Markdown/Mermaid generation
├── enrichment.py          # AI context integration
├── navigator.py           # Anchor point navigation
├── config.py              # Configuration constants
├── utils.py               # Helper functions
├── requirements.txt       # Python dependencies
├── README.md              # This file
├── .gitignore
└── tests/
    ├── test_parser.py
    ├── test_generator.py
    └── test_integration.py

支持的语言

  • TypeScript(.ts, .tsx)
  • JavaScript(.js, .jsx, .mjs, .cjs)
  • python.py)

可选AI增强

集 ANTHROPIC_API_KEY 环境变量,以启用自动AI生成的上下文:

export ANTHROPIC_API_KEY=your_key_here

然后使用 build_hive 和 enrich_with_ai: true.

许可证

麻省理工学院