Scribe

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.

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

概览

AI 生成的概览

Writulos Scribe 的 MCP 服务器,让助手为单个代码文件或最多 20 个文件的批次生成 Markdown 文档。

可以做什么
  • 为单个代码文件生成 Markdown 文档,可选提供文件名和额外上下文
  • 一次请求为最多 20 个文件批量生成文档
  • 把生成的文档返回聊天中,由客户端自行保存
  • 写入运行日志,记录每次运行和本月剩余生成次数
适用场景
适合希望在不离开聊天的情况下,让 AI 助手为现有源码文件生成 Markdown 文档的场景,可单文件处理,也可一次处理最多 20 个文件。
运行要求
通过 npx 或全局 npm 安装以 stdio 在本地运行;需要 Node.js 18 及以上版本,并在 WRITULOS_API_KEY 中提供 Writulos Scribe API 密钥。可选 WRITULOS_API_URL、WRITULOS_OUTPUT_DIR 和 WRITULOS_PROJECT_ROOT 用于调整接口地址和运行日志位置。需要能访问 Writulos API 的网络。
安装前请注意
需要 Writulos API 密钥,通过环境变量传入。每记录一个文件会消耗账户月度套餐中的一次生成额度,与仪表盘和 GitHub Action 共用同一额度。源代码会发送到 Writulos 服务处理。服务器会在项目根目录下写入运行日志。

安装

在 SourceWeft 中

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

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

其他 MCP 客户端

参照 仓库 中的启动说明。

README

writulos-mcp

Official MCP server for Writulos Scribe — generate markdown documentation for your code inside Cursor, Claude Desktop, and any MCP-compatible AI agent.

Installation

No install needed. Run directly with npx:

bash
npx writulos-mcp

Or install globally:

bash
npm install -g writulos-mcp

Setup in Cursor

Add this to .cursor/mcp.json in your project root:

json
{  "mcpServers": {    "writulos": {      "command": "npx",      "args": ["-y", "writulos-mcp"],      "env": {        "WRITULOS_API_KEY": "writ_YOUR_API_KEY"      }    }  }}

Restart Cursor. Then in the AI chat, ask:

Document all the files in this project using writulos

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.

Setup in Claude Code, Claude Desktop and other clients

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.

Usage and limits

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.

Tools

generate_docs

Generate markdown documentation for a single code file.

Inputs:

  • code (required) — the source code
  • filename (optional) — e.g. auth.js
  • context (optional) — extra context about the file

generate_docs_batch

Generate markdown documentation for up to 20 files in one request.

Inputs:

  • files (required) — array of { code, filename?, context? } objects

Requirements

Source and issues

This repository is a copy of the server, updated on every release. Report bugs and ask questions in its issues.

License

MIT

来源:README.md,提交 b78fbdc

工具

2

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

generate_docs_batch

Generate 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必填

版本历史

2
  1. v1.0.3最新Oct 21, 2026
  2. v1.0.2Sep 16, 2026

评分

已满足适用检查项的 90%

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

  • 近 30 天内可连通25 分
  • 已声明认证方式10 分

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

  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分