English Français العربية

com.writulos/scribe

Official registry Developer tools

Generate clean markdown documentation for your code — one file, or up to 20 in one batch.

Source code Website Documentation

Install

Add this to your client's MCP configuration (Claude Desktop: claude_desktop_config.json; Cursor: .cursor/mcp.json; VS Code and others use the same "mcpServers" shape).

NPM package writulos-mcp
Claude Code 
claude mcp add scribe -e 'WRITULOS_API_KEY=<your writulos_api_key>' -e 'WRITULOS_OUTPUT_DIR=<WRITULOS_OUTPUT_DIR>' -e 'WRITULOS_PROJECT_ROOT=<WRITULOS_PROJECT_ROOT>' -e 'WRITULOS_API_URL=<WRITULOS_API_URL>' -- npx -y writulos-mcp@1.0.3
JSON configuration (Claude Desktop, Cursor, VS Code) 
{
    "mcpServers": {
        "scribe": {
            "command": "npx",
            "args": [
                "-y",
                "writulos-mcp@1.0.3"
            ],
            "env": {
                "WRITULOS_API_KEY": "<your writulos_api_key>",
                "WRITULOS_OUTPUT_DIR": "<WRITULOS_OUTPUT_DIR>",
                "WRITULOS_PROJECT_ROOT": "<WRITULOS_PROJECT_ROOT>",
                "WRITULOS_API_URL": "<WRITULOS_API_URL>"
            }
        }
    }
}

Environment variables

  • WRITULOS_API_KEY required secret Your Writulos Scribe API key, from https://scribe.writulos.com/dashboard/api-keys
  • WRITULOS_OUTPUT_DIR Directory for the run log (writulos.log). Defaults to "docs", relative to the project root.
  • WRITULOS_PROJECT_ROOT Project root the run log is written under. Defaults to the working directory.
  • WRITULOS_API_URL Override the API base URL, for testing against another deployment. Defaults to https://scribe.writulos.com/api

Documentation

From the project's README on GitHub, refreshed weekly. Links open on GitHub.

Contents
  1. writulos-mcp
  2. Installation
  3. Setup in Cursor
  4. Setup in Claude Code, Claude Desktop and other clients
  5. Usage and limits
  6. Tools
  7. Requirements
  8. Source and issues
  9. License

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:

npx writulos-mcp

Or install globally:

npm install -g writulos-mcp

Setup in Cursor

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

{
  "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

Frequently asked questions

What is com.writulos/scribe?

Generate clean markdown documentation for your code — one file, or up to 20 in one batch.

How do I install com.writulos/scribe?

It runs on your machine. In Claude Code: claude mcp add scribe -e 'WRITULOS_API_KEY=<your writulos_api_key>' -e 'WRITULOS_OUTPUT_DIR=<WRITULOS_OUTPUT_DIR>' -e 'WRITULOS_PROJECT_ROOT=<WRITULOS_PROJECT_ROOT>' -e 'WRITULOS_API_URL=<WRITULOS_API_URL>' -- npx -y writulos-mcp@1.0.3. For other clients, paste the JSON configuration from this page into their MCP settings.

Does com.writulos/scribe need an API key?

Yes. It expects WRITULOS_API_KEY, which you set in its configuration.

Is com.writulos/scribe open source?

Yes. Its code is on GitHub under the MIT license.

Who maintains com.writulos/scribe?

It is published by writulos. AI.tn lists it but does not maintain or endorse it.

From the official MCP Registry. Listing is not an endorsement: review a server's code and permissions before giving it access to your data.