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