Skip to main content
Glama
writulos-mcp

writulos-mcp

Official
by writulos

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

Related MCP server: Functional Requirements MCP Server

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

Available Tools

2 tools
generate_docsGenerate docs for a fileA

Generate markdown documentation for a single code file using Writulos. Uses one generation from the account's monthly allowance.

Inputs: code (required), context, filename.

generate_docs_batchGenerate docs for several filesA

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.

Inputs: files (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.9/5.0

    Scored across 2 tools

    Disambiguation5/5

    The two tools have clearly distinct purposes: generate_docs handles a single file while generate_docs_batch handles multiple files (up to 20). The boundary between them is unambiguous, so an agent can select correctly.

    Naming Consistency5/5

    Both names follow a consistent snake_case verb_noun pattern (generate_docs), with the batch variant distinguished by a clean suffix. No mixed conventions or stylistic drift.

    Tool Count3/5

    Two tools is on the thin side for the stated domain. While each tool earns its place, the surface feels minimal and could likely support additional operations like allowance checks or retrieval.

    Completeness3/5

    The server covers the core documentation-generation action, but there are notable gaps: no way to check remaining monthly allowance, list previously generated docs, or retrieve/read generated output. Agents will hit dead ends for anything beyond fire-and-forget generation.

    Related MCP Connectors

    Related MCP Servers

    • F
      license
      Not graded
      quality
      D
      maintenance
      MCP server that exposes one or more documentation folders (Markdown, MDX, TXT) to AI agents, enabling listing, reading, and searching of documentation files.
      -
    • A
      license
      Not graded
      quality
      B
      maintenance
      MCP server that studies a folder of code repositories, generates markdown documentation (architecture, interfaces, activity), and serves answers over MCP with live ripgrep search and file reads so AI assistants can query codebases and their relationships.
      9 npm
      MIT