Documenter MCP

MCP文档服务器

该项目实现了一个MCP（模型协调协议）服务器，用于自动代码文档分析和检查。它侧重于在不修改源文件的情况下，识别多种编程语言代码库中的文档问题。

特性

• 多语言支持：适用于Python、JavaScript/TypeScript、Java、C++、Go等
• 文件检查：验证文件的存在、格式和完整性
• 文件评估：评估代码的清晰度、一致性和同步性
• MCP集成：作为MCP服务器与其他工具集成

安装

pip install -r requirements.txt

用法

命令行接口

# Analyze a project for documentation issues
python -m src.server analyze /path/to/project

# Check documentation without making changes
python -m src.server check /path/to/project

作为MCP服务器

# Run as MCP server
python -m src.server --mcp

配置

服务器可以使用YAML或TOML配置文件进行配置。看 config.example.yaml 作为示例配置。

项目结构

src/
├── cli.py              # Command-line interface
├── server.py           # Main MCP server implementation
├── config.py           # Configuration management
├── logger.py           # Logging setup
├── models.py           # Data models
├── core/
│   └── orchestrator.py # Core orchestration logic
├── parsers/
│   ├── base.py         # Base parser and Python parser
│   └── __init__.py
├── analyzers/
│   ├── checker.py      # Documentation checking
│   ├── evaluator.py    # Documentation evaluation
│   └── __init__.py
└── generators/
    └── __init__.py

发展

贡献

1. 分叉存储库
2. 创建要素分支
3. 进行更改
4. 运行测试
5. 提交拉取请求

许可证

MIT许可证-有关详细信息，请参阅许可证文件。