代码文档扫描工具

docscope mcp

扫描你的代码库，找到丢失、错误或过时的文档。

🧭 意图

代码文档服务于两个受众：稍后阅读的人类和现在阅读的AI代理。此工具推动 故意过多记录 --比通常要求的更高程度的文档，将丰富的上下文直接放置在代码旁边。

这对单元测试尤其重要：在Python中，测试失败输出中会出现文档字符串，因此一个记录良好的测试函数可以为您提供 为什么 旁边 什么失败了更广泛地说，前提是函数级文档是最接近代码本身的上下文，比README文件、架构文档或wiki更接近。通过用详细的文档字符串丰富每个函数，您可以使代码库在有限的上下文窗口内对人类和人工智能代理进行自我描述。

该工具扫描代码库，对每个函数的文档质量进行评分，按优先级对其进行排名，并找出最严重的差距——这样你就可以修复重要的问题，而不是猜测。它提高了文档质量 可测量和可试验。

设计遵循 人工智能意图转移原理MCP接口在对话流中保持分析（意图引导），质量分数使评估可检查，优先级排名根据结果校准努力。

这些原则塑造了项目本身： 项目计划 记录每个阶段的目标和风险态势，以及 期刊 捕捉到了设计权衡，包括为什么尽管存在已知的精度限制，但选择正则表达式解析而不是外部AST库。

安装

pip install git+https://github.com/mgrandau/docscope-mcp.git

然后配置VS Code以使用MCP服务器：

docscope-mcp install

这将服务器添加到 .vscode/mcp.json 在您当前的工作空间中。重新加载VS代码以激活。

工作区安装还会复制：

• 提示 → .github/prompts/ （用于代码分析的AI提示模板）
• 工具集 → utils/ （批量分析脚本）

全局安装（可选）

要为所有VS Code工作区全局安装：

# VS Code (stable)
docscope-mcp install --global

# VS Code Insiders
docscope-mcp install --global --insiders

用法

MCP服务器（VS代码副本）

安装后 analyze_functions MCP工具在VS Code Copilot和其他MCP兼容客户端中可用。

CLI分析

直接从命令行分析源文件，这对CI/CD管道、脚本和基于终端的工作流很有用：

# Analyze a single file
docscope-mcp analyze src/main.py

# Analyze multiple files
docscope-mcp analyze src/*.py

# JSON output for pipelines
docscope-mcp analyze src/main.py --format json

# Analyze inline code (requires --language)
docscope-mcp analyze --code "def foo(): pass" --language python

# Short flags
docscope-mcp analyze -c "def foo(): pass" -l python -f json

支持的语言: python, csharp, vb, vb6, c_cpp

卸载

# Workspace
docscope-mcp uninstall

# Global (stable)
docscope-mcp uninstall --global

# Global (Insiders)
docscope-mcp uninstall --global --insiders

架构文档

对于AI可读的架构合同和详细的组件文档：

💬 社区

💬 加入Discord社区