Code analysis and documentation tool with MCP support
Project description
CodeDoc MCP
CodeDoc MCP是一个强大的代码分析和文档生成工具,支持多种编程语言,能够自动生成Markdown文档和Mermaid图表。
功能特点
- 多语言支持:支持Python、C#、C++、JavaScript和Unity着色器等多种编程语言
- 文档生成:自动生成详细的Markdown格式文档
- 图表生成:生成Mermaid格式的类图、流程图和结构图
- MCP服务:提供MCP服务器接口,方便集成到其他工具中
- 批量处理:支持对整个目录进行批量分析和文档生成
安装方法
pip install codedoc_mcp
快速开始
命令行使用
# 分析单个文件
codedoc_mcp analyze --file path/to/your/file.py --output docs
# 分析整个目录
codedoc_mcp analyze-dir --dir path/to/your/project --output docs
Python代码中使用
from codedoc_mcp import analyze_code_file, analyze_directory
# 分析单个文件
result = analyze_code_file(
file_path="path/to/your/file.py",
output_dir="docs",
generate_markdown=True,
generate_class_diagram=True
)
# 分析整个目录
result = analyze_directory(
directory_path="path/to/your/project",
output_dir="docs",
file_extensions=[".py", ".cs"],
recursive=True
)
支持的文件类型
- Python (.py)
- C# (.cs)
- C++ (.cpp, .h, .hpp, .cc)
- JavaScript/TypeScript (.js, .jsx, .ts, .tsx)
- Unity着色器 (.shader, .compute, .cginc, .hlsl)
文档示例
生成的Markdown文档
生成的Markdown文档包含以下内容:
- 类和接口的详细描述
- 方法和函数的参数、返回值和文档字符串
- 属性和字段的类型和描述
- 继承关系和依赖关系
生成的Mermaid图表
生成的Mermaid图表包括:
- 类图:展示类之间的继承和关联关系
- 流程图:展示函数调用流程
- 结构图:展示项目结构和模块依赖关系
许可证
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
codedoc_mcp-0.1.0.tar.gz
(10.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codedoc_mcp-0.1.0.tar.gz.
File metadata
- Download URL: codedoc_mcp-0.1.0.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
12fa70b3b6fee77c46bb9b061010ef2fe25cc2211b8fe596d18c051b56c5a44a
|
|
| MD5 |
178c06bff93f42d7da935c3a639902f6
|
|
| BLAKE2b-256 |
ecf591b9151323fc366849d6fe5e8bcbfd6004325147cf76ea8cdea311a56a71
|
File details
Details for the file codedoc_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: codedoc_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92a6667257e069f74733c8e6d201343ffeebbba212ff16d629d1eda6012e2d33
|
|
| MD5 |
0029050a6c113735e5a708e9cb8f5d5c
|
|
| BLAKE2b-256 |
413975b84af16b81a2bcf333c3fcde8fc47110261f807d01a80564aa53b25218
|