Docs

io.github.rog0x由 GitHub 账号 rog0x 发布v1.0.2更新于 Oct 24, 2026

JSDoc, README, changelog generation for AI agents

已验证STDIO仅桌面知识与记忆开发者工具

概览

AI 生成的概览

让助手生成 JSDoc、README、变更日志和 REST API 文档,并检查现有文档与代码注释。

可以做什么
通过 MCP 提供五个文档工具:generate_jsdoc 根据函数签名生成带 @param、@returns、@throws 和 @example 标签的 JSDoc/TSDoc;analyze_readme 评估 README 完整度并指出缺失章节;generate_changelog 根据提交信息生成变更日志条目;generate_api_docs 根据端点定义生成 Markdown 格式的 REST API 文档;analyze_code_comments 统计注释覆盖率、查找 TODO/FIXME 标记并识别未写文档的函数。
适用场景
适合让助手撰写或审阅项目文档的场景:起草文档注释、补齐 README 缺失内容、把提交记录整理成变更日志,或为 API 编写文档。它是文本生成与分析工具,不直接连接代码仓库或 Git。
运行要求
以 Node.js 本地进程通过 stdio 运行,从 npm 包 @rog0x/mcp-docs-tools 安装并需先构建;MCP 客户端配置为用 node 启动构建后的入口文件。未声明账号、API 密钥、环境变量或请求头。
安装前请注意
未声明任何凭据或网络访问。这些工具以源代码、README 文本、提交信息和端点定义作为输入,传入内容由本地服务器处理;提交前请先审阅生成的文档。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Docs,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

mcp-docs-tools

Documentation generation tools for AI agents, served via the Model Context Protocol (MCP).

Overview

mcp-docs-tools provides five specialized documentation tools accessible through MCP:

ToolDescription
generate_jsdocGenerate JSDoc/TSDoc comments from function signatures
analyze_readmeAnalyze README completeness and suggest improvements
generate_changelogGenerate CHANGELOG entries from commit messages
generate_api_docsGenerate REST API documentation from endpoint definitions
analyze_code_commentsAnalyze comment coverage, find TODOs, detect undocumented functions

Installation

bash
npm installnpm run build

Usage

As an MCP Server

Add to your MCP client configuration:

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

Tools

generate_jsdoc

Parses a function signature and generates JSDoc/TSDoc with @param, @returns, @throws, and @example tags.

Parameters:

  • functionSignature (string, required) - The function signature to document
  • description (string, optional) - Description of the function
  • includeExample (boolean, optional, default: true) - Whether to include an @example tag
analyze_readme

Analyzes README content for required sections (Installation, Usage, License, etc.), rates completeness from 0-100, and suggests missing sections.

Parameters:

  • content (string, required) - Full text content of the README file
generate_changelog

Generates CHANGELOG entries from git-style commit messages following the Keep a Changelog format. Categorizes commits as Added, Changed, Fixed, Removed, Deprecated, or Security.

Parameters:

  • versions (array, required) - Array of { version, date, commits } objects
  • projectName (string, optional) - Project name for the header
generate_api_docs

Generates REST API documentation in Markdown from endpoint descriptions including method, URL, parameters, request/response examples, and status codes.

Parameters:

  • apiTitle (string, required) - Title for the API documentation
  • baseUrl (string, optional) - Base URL for the API
  • apiDescription (string, optional) - General API description
  • endpoints (array, required) - Array of endpoint definitions
analyze_code_comments

Analyzes source code comment coverage: computes comment-to-code ratio, finds TODO/FIXME/HACK markers, detects functions without documentation, and suggests where docs are needed.

Parameters:

  • code (string, required) - Source code to analyze
  • language (string, optional, default: "typescript") - Programming language

Configuration

No additional configuration required. The server runs over stdio.

License

MIT

来源:README.md,提交 2ae3eb1

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v1.0.2最新Sep 16, 2026

评分

已满足适用检查项的 40%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

    请在仓库或注册中心条目中声明许可证。