Back to Browse

Writulos MCP Server

Developer ToolsModerate5.3MCP RegistryLocal
Free

Server data from the Official MCP Registry

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

About

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

Security Report

5.3
Moderate5.3Moderate Risk

The server is a thin client that forwards user-supplied source code to the vendor's Writulos API using a bearer-style API key from an environment variable, which matches its documentation-generation purpose. No malicious patterns, shell execution, or hardcoded credentials were found; the main concerns are that submitted code leaves the machine by design and that configuration variables can redirect the API endpoint and log directory. Supply chain analysis found 5 known vulnerabilities in dependencies (0 critical, 3 high severity). Package verification found 1 issue.

3 files analyzed · 10 issues found

Security scores are indicators to help you make informed decisions, not guarantees. Always review permissions before connecting any MCP server.

Permissions Required

This plugin requests these system permissions. Most are normal for its category.

HTTP Network Access

Connects to external APIs or services over the internet.

File System Write

Writes or modifies files on your machine. Check that this is expected for the tool.

env_vars

Check that this permission is expected for this type of plugin.

What You'll Need

Set these up before or after installing:

Your Writulos Scribe API key, from https://scribe.writulos.com/dashboard/api-keysRequired

Environment variable: WRITULOS_API_KEY

Directory for the run log (writulos.log). Defaults to "docs", relative to the project root.Optional

Environment variable: WRITULOS_OUTPUT_DIR

Project root the run log is written under. Defaults to the working directory.Optional

Environment variable: WRITULOS_PROJECT_ROOT

Override the API base URL, for testing against another deployment. Defaults to https://scribe.writulos.com/apiOptional

Environment variable: WRITULOS_API_URL

How to Install

Add this to your MCP configuration file:

{
  "mcpServers": {
    "com-writulos-scribe": {
      "env": {
        "WRITULOS_API_KEY": "your-writulos-api-key-here",
        "WRITULOS_API_URL": "your-writulos-api-url-here",
        "WRITULOS_OUTPUT_DIR": "your-writulos-output-dir-here",
        "WRITULOS_PROJECT_ROOT": "your-writulos-project-root-here"
      },
      "args": [
        "-y",
        "writulos-mcp"
      ],
      "command": "npx"
    }
  }
}

Documentation

View on GitHub

From the project's GitHub 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:

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

Reviews

No reviews yet

Be the first to review this server!