Documentation Assistant

文件助理

一个全面的MCP（模型上下文协议）服务器，可以自动分析Python代码库并生成专业文档。

特性

• 存储库扫描：自动发现和分析Python文件
• 文档生成：创建自述文件、API文档和安装指南
• 交互式帮助：解释特定的函数和类
• 依赖项跟踪：标识所有导入和包
• MCP集成：与Claude Desktop无缝协作

快速开始

安装

1. 克隆存储库：

git clone https://github.com/YOUR_USERNAME/documentation-assistant.git
cd documentation-assistant

1. 创建虚拟环境：

python -m venv venv

# On Windows:
venv\Scripts\activate

# On Mac/Linux:
source venv/bin/activate

1. 安装依赖项：

pip install -r requirements.txt

配置

添加到您的Claude Desktop配置文件中：

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

{
  "mcpServers": {
    "documentation-assistant": {
      "command": "python",
      "args": ["/absolute/path/to/doc_assistant_mcp.py"]
    }
  }
}

可用工具

• scan_repository -分析目录中的Python文件
• generate_readme -创建全面的README
• generate_api_docs -生成API文档
• generate_setup_guide -创建设置说明
• explain_code -解释具体的功能/类
• list_dependencies -显示所有项目依赖关系

文档

• 集成指南 -完整的设置说明
• API 文档 -生成的示例文档
• 安装指南 -安装和配置
• 对话日志 -使用示例
• 项目概要 -技术细节

测试

运行测试套件：

python test_client.py

需求

• Python 3.8+
• MCP-SDK
• requirements.txt中列出的依赖项

许可证

MIT许可证

贡献

欢迎投稿！请先阅读投稿指南。

支持

对于问题或疑问，请在GitHub上打开问题。

作者

可怕的--lubainahumayoun@gmail.com

致谢

• 使用MCP（模型上下文协议）构建
• 使用Python AST进行代码分析