generate_docs
Generate docs for a file
Generate markdown documentation for a single code file using Writulos. Uses one generation from the account's monthly allowance.
code必填contextfilename
com.writulos由 writulos.com 發布v1.0.3更新於 Nov 4, 2026
Generate clean markdown documentation for your code — one file, or up to 20 in one batch.
Writulos Scribe 的 MCP 伺服器,讓助理為單一程式碼檔案或最多 20 個檔案的批次產生 Markdown 文件。
Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。
參照 儲存庫 中的啟動說明。
Official MCP server for Writulos Scribe — generate markdown documentation for your code inside Cursor, Claude Desktop, and any MCP-compatible AI agent.
No install needed. Run directly with npx:
Or install globally:
Add this to .cursor/mcp.json in your project root:
Restart Cursor. Then in the AI chat, ask:
The generated docs come back in the chat — ask Cursor to save them wherever you
keep documentation. The server itself only writes a run log to
docs/writulos.log (set WRITULOS_OUTPUT_DIR to move it), recording each run
and how many generations you have left this month.
Use the same command, args and env as the Cursor config above. Whichever
way the client adds the server, give it WRITULOS_API_KEY: without the key the
server still starts, and every tool call answers with where to get one.
Each file documented uses one generation from your Writulos plan's monthly allowance, the same allowance the dashboard and the GitHub Action draw on. When it runs out, the tools say so and when it resets.
generate_docsGenerate markdown documentation for a single code file.
Inputs:
code (required) — the source codefilename (optional) — e.g. auth.jscontext (optional) — extra context about the filegenerate_docs_batchGenerate markdown documentation for up to 20 files in one request.
Inputs:
files (required) — array of { code, filename?, context? } objectsThis repository is a copy of the server, updated on every release. Report bugs and ask questions in its issues.
MIT
來源:README.md,提交 b78fbdc
Generate docs for a file
Generate markdown documentation for a single code file using Writulos. Uses one generation from the account's monthly allowance.
code必填contextfilenameGenerate docs for several files
Generate markdown documentation for multiple code files in one request (up to 20 files). Uses one generation per file from the account's monthly allowance.
files必填已滿足適用檢查項的 90%
該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。
請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。
npx writulos-mcpnpm install -g writulos-mcp{ "mcpServers": { "writulos": { "command": "npx", "args": ["-y", "writulos-mcp"], "env": { "WRITULOS_API_KEY": "writ_YOUR_API_KEY" } } }}Document all the files in this project using writulos