English Français العربية

com.writulos/scribe

Registre officiel Outils de développement

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

Code source Site web Documentation

Installation

Ajoutez ceci à la configuration MCP de votre client (Claude Desktop : claude_desktop_config.json ; Cursor : .cursor/mcp.json ; VS Code et les autres utilisent la même forme « mcpServers »).

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
Configuration JSON (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>"
            }
        }
    }
}

Variables d'environnement

  • WRITULOS_API_KEY obligatoire 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

Tirée du README du projet sur GitHub, actualisée chaque semaine. Les liens ouvrent GitHub.

Sommaire
  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

Questions fréquentes

Qu'est-ce que com.writulos/scribe ?

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

Comment installer com.writulos/scribe ?

Il s'exécute sur votre machine. Dans 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. Pour les autres clients, collez la configuration JSON de cette page dans leurs réglages MCP.

Faut-il une clé API pour com.writulos/scribe ?

Oui. Il attend WRITULOS_API_KEY, à renseigner dans sa configuration.

com.writulos/scribe est-il open source ?

Oui. Son code est sur GitHub sous licence MIT.

Qui maintient com.writulos/scribe ?

Il est publié par writulos. AI.tn le référence sans le maintenir ni le recommander.

Issu du registre MCP officiel. Être listé n'est pas une recommandation : vérifiez le code et les permissions d'un serveur avant de lui donner accès à vos données.