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 調整 API 位址與執行紀錄位置。需要能連線至 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 分