mcpField
D
docs

docs

本地服务
github.com/rog0x开发工具032 周前更新
代码仓库

关于 docs

面向 AI Agent 的 MCP 服务，用于生成和检查 JSDoc、README、变更日志及 REST API 文档，也能分析代码注释覆盖率与文档缺漏。

主要功能

  1. 01生成 JSDoc 和 TSDoc
  2. 02检查 README 完整度
  3. 03生成变更日志条目
  4. 04生成 REST API 文档
  5. 05查找代码注释缺漏

适用场景

  1. 01根据函数签名编写文档
  2. 02找出 README 缺失章节
  3. 03将提交消息整理为变更日志
  4. 04检查代码中的 TODO 和未文档化函数

MCP 相关

通过 stdio 向 MCP 客户端提供五种文档生成与分析工具。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "rog0x-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@rog0x/mcp-docs-tools"
      ]
    }
  }
}
启动命令npx -y @rog0x/mcp-docs-tools

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npm@rog0x/mcp-docs-tools1.0.2

工具

5

收录的工具列表 · 更新于 3 周前

参数类型必填说明
descriptionstring否函数功能的可选说明
includeExampleboolean否是否包含 @example 标签
functionSignaturestring是要编写文档的函数签名，例如 'async function fetchUser(id: string): Promise<User>'

详细介绍

mcp-docs-tools

通过模型上下文协议（MCP）提供给 AI Agent 使用的文档生成工具。

概览

mcp-docs-tools 通过 MCP 提供五种专用文档工具：

工具描述
generate_jsdoc根据函数签名生成 JSDoc/TSDoc 注释
analyze_readme分析 README 的完整性并提出改进建议
generate_changelog根据提交消息生成 CHANGELOG 条目
generate_api_docs根据端点定义生成 REST API 文档
analyze_code_comments分析注释覆盖率、查找 TODO、检测未编写文档的函数

安装

npm install
npm run build

使用方法

作为 MCP 服务

添加到 MCP 客户端配置中：

{
  "mcpServers": {
    "docs-tools": {
      "command": "node",
      "args": ["path/to/mcp-docs-tools/dist/index.js"]
    }
  }
}
工具
generate_jsdoc

解析函数签名，并生成包含 @param、@returns、@throws 和 @example 标签的 JSDoc/TSDoc。

参数：

  • functionSignature（string，必填）- 要编写文档的函数签名
  • description（string，可选）- 函数描述
  • includeExample（boolean，可选，默认值：true）- 是否包含 @example 标签
analyze_readme

分析 README 内容，检查是否包含必需的章节（安装、使用方法、许可证等），评估完整度（0-100），并建议补充缺失的章节。

参数：

  • content（string，必填）- README 文件的完整文本内容
generate_changelog

根据 git 风格的提交消息，按照 Keep a Changelog 格式生成 CHANGELOG 条目。将提交归类为 Added、Changed、Fixed、Removed、Deprecated 或 Security。

参数：

  • versions（array，必填）- { version, date, commits } 对象数组
  • projectName（string，可选）- 标题中使用的项目名称
generate_api_docs

根据端点说明生成 Markdown 格式的 REST API 文档，内容包括方法、URL、参数、请求/响应示例和状态码。

参数：

  • apiTitle（string，必填）- API 文档标题
  • baseUrl（string，可选）- API 的基础 URL
  • apiDescription（string，可选）- API 的总体描述
  • endpoints（array，必填）- 端点定义数组
analyze_code_comments

分析源代码注释覆盖情况：计算注释与代码的比例、查找 TODO/FIXME/HACK 标记、检测缺少文档的函数，并建议需要补充文档的位置。

参数：

  • code（string，必填）- 要分析的源代码
  • language（string，可选，默认值："typescript"）- 编程语言

配置

无需额外配置。服务通过 stdio 运行。

许可证

MIT

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。