MCP Doc Bot

MCP开发工具

提供方 Mishail01

开发工具 stdio · 本地进程 会话登录 社区 / 第三方
查看接入方式

一个Python工具,用于扫描Python代码库,提取API详细信息,并生成开发者友好的Markdown文档,包括模拟的MCP接口以交互式查询代码元素。

一句话选型结论

按资料字段整理

MCP Doc Bot 属于开发工具类 MCP 服务器,stdio · 本地进程,会话登录,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式stdio · 本地进程 鉴权会话登录 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

适用场景

代码分析Python本地部署文档生成开发者工具Python工具API文档

安装与配置

stdio · 本地进程 会话登录
客户端在本机拉起子进程,数据不出本机
python -m venv .venv

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Python,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好会话登录对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
MCP Doc Bot当前 未标注 stdio · 本地进程 本地部署 有 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方Mishail01上游标注的维护方 Mishail01
分类开发工具本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式会话登录远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Python本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

7.3 KB
来自项目仓库与上游目录的原文,未做删改

MCP开发人员文档机器人

一个Python工具,它扫描Python代码库,提取API详细信息,并在Markdown中生成开发人员友好的文档。它还包括一个模拟的MCP界面,因此您可以就函数、类和模块提出交互式问题,并生成示例对话日志。

此存储库旨在作为参考实现和入门工具包,用于构建由类似MCP的接口驱动的文档助理。


目录

  • 特性
  • 快速演示
  • 安装
  • 用法
  • 生成文档
  • 交互式MCP会话(模拟)
  • PowerShell交钥匙脚本
  • 项目结构
  • 运作原理
  • 存储库扫描和解析
  • 文档生成
  • MCP模拟接口
  • 输出/示例
  • 配置和要求
  • 扩展bot
  • 贡献
  • 许可证和联系方式

特性

核心

  • 存储库扫描:在目标目录中递归查找.py文件。
  • 基于AST的解析:提取函数、类、方法签名、参数和文档字符串。
  • 文档生成:使用Jinja2模板在Markdown中创建一个项目README和一个详细的API文档。
  • 交互式MCP(模拟):一个简单的CLI服务器,可以回答有关代码元素的问题并记录对话。

计划的

  • 依赖关系映射和可视化图形
  • 图生成(UML/类图)
  • 与Git集成的版本化文档

快速演示

  1. 为示例仓库生成文档并检查输出:
  • python run.py测试/example_repo
  • 输出被写入 sample_output/
  1. 启动模拟MCP交互会话:
  • python run_mcp_logging.py
  • 示例查询:解释(“添加”),解释(“计算器”)

安装

需求

  • Python 3.8+
  • 点
  1. 克隆```bash
    git clone https://github.com//mcp-doc-bot.git
    cd mcp-doc-bot

2. (可选)创建并激活虚拟环境```bash
python -m venv .venv
# macOS / Linux
source .venv/bin/activate
# Windows (PowerShell)
.\.venv\Scripts\Activate.ps1
  1. 安装依赖项```bash
    pip install --upgrade pip
    pip install -r requirements.txt

注意:requirements.txt至少应包括:

- jinja2

如果您使用额外的功能,请添加graphviz、pydot或Sphinx等包。

______________________________________________________________________

## 用法

## 生成文档```bash
python run.py  [--out sample_output] [--templates templates/]
  • 例子:```
  • python run.py tests/example_repo
- 主要输出:```
- sample_output/README.md — generated project README
- sample_output/api_docs.md — function/class API docs

交互式MCP会话(模拟)```bash

python run_mcp_logging.py


- 启动一个CLI循环,接受以下简单命令:
- 解释(“函数名”)
- 解释(“模块.ClassName”)
- regenerate_doc()
- 日志保存到 `tests/results/mcp_conversation_log.txt` (或配置的路径)。

## PowerShell交钥匙脚本

- run_bot.ps1一步完成venv创建、依赖项安装、扫描和生成文档的自动化:```powershell
.\run_bot.ps1 -TargetPath "tests/example_repo"

(调整脚本参数以适应您的环境。)


项目结构```

mcp-doc-bot/
│
├── bot/
│ ├── init.py
│ ├── scanner.py # Repository crawler
│ ├── parser.py # AST-based code analysis
│ ├── generator.py # Jinja2-based docs generation
│ ├── mcp_server.py # Mocked MCP interface / CLI
│
├── templates/
│ ├── readme_template.md
│ ├── api_template.md
│
├── sample_output/ # Example generated outputs
│ ├── README.md
│ ├── api_docs.md
│
├── tests/
│ ├── example_repo/ # Small demo repo used for tests
│ │ ├── simple_functions.py
│ │ ├── sample_class.py
│ ├── results/
│ └── mcp_conversation_log.txt
│
├── requirements.txt
├── run.py # CLI entry: generate docs
├── run_mcp_logging.py # Run mocked MCP and write logs
├── run_bot.ps1 # Windows convenience script
└── README_submission.md # Optional submission notes
```


运作原理

存储库扫描和解析

  • scanner.py遍历目标目录并列出Python文件。
  • parser.py使用Python的AST模块解析每个文件,提取:
  • 函数和方法名称、参数(包括默认值和注释)
  • 类定义及其方法
  • 顶级文档字符串和内联文档字符串
  • 解析器输出生成器.py使用的结构化表示(JSON/dict)。

文档生成

  • generator.py将Jinja2模板渲染为Markdown:
  • 包含项目概述、安装步骤和顶级模块摘要的自述文件。
  • API文档列出模块、类、函数、签名和文档字符串。
  • 模板存在于模板中/便于定制。

MCP模拟接口

  • mcp_server.py是一个简化的类似mcp的CLI服务器:
  • 将上次扫描索引加载到内存中。
  • 接受类似人类的命令并返回有用的摘要。
  • 将会话日志写入tests/results/*.txt以演示对话。

输出/示例

  • sample_output/README.md

  • 项目总结、如何运行以及简短的示例部分。

  • sample_output/api_docs.md

  • 按模块组织,包括:

  • 函数签名和文档字符串
  • 类定义、构造函数和方法摘要
  • 当文档字符串包含示例时的示例用法片段

  • 测试/结果/mcpconversation_log.txt

  • 显示解释(“添加”)和解释(“计算器”)响应的示例对话

在您的提交中包含这些示例输出,以显示机器人的功能。


配置和要求

  • Python版本:3.8+
  • 推荐的软件包(requirements.txt):
  • jinja2
  • (可选)graphviz、pydot、sphinx用于高级功能
  • 跨平台:Windows、macOS、Linux
  • 如果在受限环境(CI)中运行,请提供较小的目标路径以加快扫描速度。

扩展bot

要添加的想法:

  • 图生成:集成graphviz绘制类/模块依赖图。
  • Sphinx输出:将生成的Markdown转换为reStructuredText并构建HTML文档。
  • Git集成:检测更改,只为修改后的模块重新生成文档。
  • 自然语言改进:用实时MCP客户端/SDK替换模拟MCP,以回答更自然的查询。

如果您添加功能,请:

  • 在测试中添加测试/
  • 更新模板/
  • README_submission.md中的文档使用

贡献

  1. 分叉回购
  2. 创建特征分支(特征/你的特征)
  3. 编写测试和更新文档
  4. 打开一个描述变化和动机的PR

请保持更改的重点(每个PR一个功能/错误修复),并包括生成文档的示例。


许可证和联系方式

该项目“按原样”提供,用于教育和原型制作目的,并获得麻省理工学院许可。

作者

沙伊尔


致谢

  • 使用Python的AST模块和Jinja2进行模板构建。
  • 受到自动化代码文档和开发人员辅助工具方法的启发。

常见问题

7 问
答案由本站依据条目字段整理,不引用上游原文
MCP Doc Bot 怎么安装?

在客户端按下面的安装命令接入:python -m venv .venv。装完在客户端配置里引用同一个包或端点。

MCP Doc Bot 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

MCP Doc Bot 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

MCP Doc Bot 需要 API Key 吗?

资料标注需要会话登录认证,使用前准备好对应凭据,并按最小权限配置。

MCP Doc Bot 能提供哪些能力?

资料显示能力标签包括 代码分析、开发工具、Python、文档生成、API文档。具体工具清单以官方文档为准。

MCP Doc Bot 需要什么运行环境?

运行时为 Python;属于本地进程,需要在本机装好运行环境。

MCP Doc Bot 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。