
Docs
io.github.rog0x由 GitHub 帳號 rog0x 發布v1.0.2更新於 Oct 24, 2026
JSDoc, README, changelog generation for AI agents
概覽
讓助理產生 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 金鑰、環境變數或標頭。
安裝
在 SourceWeft 中
- 開啟 儀表板中的 Docs,將其新增到工作區。
- 為需要使用其工具的對話啟用該服務。
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:
Installation
Usage
As an MCP Server
Add to your MCP client configuration:
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 documentdescription(string, optional) - Description of the functionincludeExample(boolean, optional, default: true) - Whether to include an@exampletag
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 }objectsprojectName(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 documentationbaseUrl(string, optional) - Base URL for the APIapiDescription(string, optional) - General API descriptionendpoints(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 analyzelanguage(string, optional, default: "typescript") - Programming language
Configuration
No additional configuration required. The server runs over stdio.
License
MIT
來源:README.md,提交 2ae3eb1
工具
0版本歷史
1- v1.0.2最新Sep 16, 2026
評分
已滿足適用檢查項的 40%
該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。
- 近 30 天內可連通25 分
請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。
- 已宣告認證方式10 分
請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。
- 已列出工具15 分
請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。
- 描述必需15 分
- 圖示10 分
- 文件15 分
- 授權條款10 分
請在儲存庫或註冊中心條目中宣告授權條款。