mcpField
S
scribe

scribe

本地服务
scribe.writulos.com开发工具02 周前更新
代码仓库访问官网

关于 scribe

scribe 是面向 Writulos Scribe 用户和 MCP 兼容客户端的 MCP 服务，可从源代码生成 Markdown 文档。它支持单个文件或最多 20 个文件的批量处理，并将结果返回客户端聊天中。

主要功能

  1. 01为单个代码文件生成 Markdown
  2. 02批量处理最多 20 个文件
  3. 03接受文件名和补充上下文
  4. 04在客户端聊天中返回文档
  5. 05将运行记录写入日志文件

适用场景

  1. 01编写代码时为源文件生成文档
  2. 02为一组文件批量生成文档
  3. 03补充文件文档所需的上下文

MCP 相关

该服务向 MCP 客户端提供 `generate_docs` 和 `generate_docs_batch`。生成文档需要 Writulos Scribe API 密钥。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "com-writulos-scribe": {
      "command": "npx",
      "args": [
        "-y",
        "writulos-mcp"
      ],
      "env": {
        "WRITULOS_API_KEY": "<WRITULOS_API_KEY>",
        "WRITULOS_OUTPUT_DIR": "<WRITULOS_OUTPUT_DIR>",
        "WRITULOS_PROJECT_ROOT": "<WRITULOS_PROJECT_ROOT>",
        "WRITULOS_API_URL": "<WRITULOS_API_URL>"
      }
    }
  }
}
启动命令npx -y writulos-mcp
需要配置的环境变量
WRITULOS_API_KEY密钥Your Writulos Scribe API key, from https://scribe.writulos.com/dashboard/api-keys
WRITULOS_OUTPUT_DIRDirectory for the run log (writulos.log). Defaults to "docs", relative to the project root.
WRITULOS_PROJECT_ROOTProject root the run log is written under. Defaults to the working directory.
WRITULOS_API_URLOverride the API base URL, for testing against another deployment. Defaults to https://scribe.writulos.com/api

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npmwritulos-mcp1.0.3

工具

2

收录的工具列表 · 更新于 1 周前

参数类型必填说明
codestring是要生成文档的源代码。
contextstring否有关文件或项目的可选补充上下文。
filenamestring否文件名，例如 auth.js

详细介绍

writulos-mcp

Writulos Scribe 的官方 MCP 服务，可在 Cursor、Claude Desktop 以及任何兼容 MCP 的 AI Agent 中为代码生成 Markdown 文档。

安装

无需安装，直接使用 npx 运行：

npx writulos-mcp

或全局安装：

npm install -g writulos-mcp

在 Cursor 中设置

将以下内容添加到项目根目录下的 .cursor/mcp.json：

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

重启 Cursor。然后在 AI 聊天中询问：

Document all the files in this project using writulos

生成的文档会返回到聊天中，可让 Cursor 将其保存到你存放文档的位置。服务本身只会在 docs/writulos.log 中写入运行日志（设置 WRITULOS_OUTPUT_DIR 可更改其位置），记录每次运行以及本月剩余的生成次数。

在 Claude Code、Claude Desktop 和其他客户端中设置

使用与上述 Cursor 配置相同的 command、args 和 env。无论客户端通过何种方式添加服务，都要为其提供 WRITULOS_API_KEY：没有密钥时，服务仍会启动，但每次工具调用都会告知获取密钥的方式。

使用方法和限制

每个文档化文件都会消耗 Writulos 套餐每月额度中的一次生成次数，与控制面板和 GitHub Action 使用的是同一额度。额度用完时，工具会告知你，并说明何时重置。

工具

generate_docs

为单个代码文件生成 Markdown 文档。

输入：

  • code（必需）— 源代码
  • filename（可选）— 例如 auth.js
  • context（可选）— 有关该文件的额外上下文
generate_docs_batch

在一次请求中为最多 20 个文件生成 Markdown 文档。

输入：

  • files（必需）— { code, filename?, context? } 对象数组

要求

源代码和问题反馈

此仓库是该服务的副本，并会在每次发布时更新。请在其 issues 中报告错误或提问。

许可证

MIT

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。