代码库导航工具

NeuroDoc MCP是一款通过context.md文件实现AI导航的代码库导航工具,提供函数、依赖关系和C4图的分层映射,比向量搜索快17-119倍且100%准确。

  • by SMH-projects
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 SMH-projects/neurodoc-mcp

使用说明

NeuroDoc MCP

通过AI导航代码库 context.md 文件夹。而不是向量搜索——函数、依赖关系和C4图的分层映射。

速度提高17至119倍 比矢量搜索· 100%准确率 · 零基础设施


快速开始

克劳德代码

全球 (所有项目----推荐):

claude mcp add --scope user ndoc -- uvx --from git+https://github.com/SMH-projects/neurodoc-mcp neurodoc-mcp

每个项目 (仅限当前项目):

claude mcp add ndoc -- uvx --from git+https://github.com/SMH-projects/neurodoc-mcp neurodoc-mcp

然后在任何项目中:

/ndoc init

克劳德桌面版

添加 ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "ndoc": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/SMH-projects/neurodoc-mcp", "neurodoc-mcp"]
    }
  }
}

VS代码/光标

添加 .vscode/mcp.json 或 ~/.cursor/mcp.json:

{
  "servers": {
    "ndoc": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/SMH-projects/neurodoc-mcp", "neurodoc-mcp"]
    }
  }
}

运作原理

NeuroDoc创建紧凑型 context.md 项目每个目录中的文件:

# auth | db, cache
auth.py: login(user,pwd) | logout(token) | refresh(token)
middleware.py: require_auth(f) | get_current_user()
tags: auth login jwt middleware
upd: 2025-01-15 ndoc

Claude在开始每个任务之前都会读取这些文件,而不是扫描数百个文件,它会立即知道:

  • 每个模块中存在哪些功能
  • 哪些模块取决于什么
  • 在哪里寻找特定的逻辑

工具

工具 说明
ndoc_init 扫描项目,生成全部 context.md 文件+C4图
ndoc_update 更新 context.md 对于已更改的文件(使用 git diff)
ndoc_validate 检查哪些模块已过时或缺少文档
ndoc_status 项目NeuroDoc状态概述

用法

添加MCP服务器后,在Claude Code中使用以下命令:

Initialize project:
> Run ndoc_init for this project

Update after changes:
> Run ndoc_update

Check status:
> Run ndoc_status

创造什么

your-project/
├── context.index.md        # Project map + C4 + dependency graph
├── CLAUDE.md               # Navigation rules for Claude (auto-updated)
├── src/
│   ├── context.md          # Module: functions, deps, tags
│   └── auth/
│       └── context.md
└── ...

context.index.md --主索引包含Mermaid依赖图和C4组件图。


需求

  • Python 3.10+
  • uv (为 uvx)
  • 克劳德代码、克劳德桌面、VS代码或光标

替代安装

# from source
git clone https://github.com/SMH-projects/neurodoc-mcp
cd neurodoc-mcp
bash install.sh

HTTP模式(自托管)

对于团队使用,请作为HTTP服务器运行:

docker compose up -d

然后通过以下方式连接:

claude mcp add ndoc --transport http http://localhost:8000/mcp

更新中

要获取最新版本:

uv cache clean neurodoc-mcp

或者强制刷新而不清除完整缓存:

uvx --from git+https://github.com/SMH-projects/neurodoc-mcp neurodoc-mcp --refresh