Skip to main content
Glama
Mhdd-24

@mhdd_24/api-documentation-mcp

by Mhdd-24

@mhdd_24/api-documentation-mcp

Generate API documentation from code/specs.

Same architecture as @mhdd_24/sublime-mcp.

Full documentation: docs/WIKI.md


How it works (30 seconds)

You (chat) → MCP client → api-documentation-mcp → API Documentation APIs / CLIs / local tools

Related MCP server: Dedalus MCP Documentation Server

Prerequisites

Requirement

Notes

Node.js 18+

ESM TypeScript MCP server

Credentials / CLIs

See environment variables below


Install

Option A — npm (after publish)

npm install -g @mhdd_24/api-documentation-mcp

Option B — npx

npx @mhdd_24/api-documentation-mcp

Option C — clone and build

git clone https://github.com/Mhdd-24/API-Documentation-MCP.git
cd API-Documentation-MCP
npm install
npm run build
node dist/index.js

Configure Cursor

Edit ~/.cursor/mcp.json:

{
  "mcpServers": {
    "apidoc": {
      "command": "npx",
      "args": ["-y", "@mhdd_24/api-documentation-mcp"],
      "env": {
        "PROJECT_ROOT": "..."
      }
    }
  }
}

Local development:

{
  "command": "node",
  "args": ["/absolute/path/to/API-Documentation-MCP/dist/index.js"]
}

Environment variables

Variable

Description

PROJECT_ROOT

Default project/repository root


Tools

Tool

Description

apidoc_status

Health check for API Documentation MCP.

apidoc_from_openapi

Generate markdown docs from OpenAPI JSON.

apidoc_from_routes

Document routes listed as method path lines.


License

ISC

Available Tools

3 tools
apidoc_from_openapiC

Generate markdown docs from OpenAPI JSON.

ParametersJSON Schema
NameRequiredDescriptionDefault
specYesOpenAPI JSON/path

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full behavioral burden, yet it says nothing about where markdown is written or returned, whether existing files are overwritten, or whether any auth/setup is required. One sentence cannot cover that for a doc-generation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with zero filler. It is efficient, though its brevity is partly the source of the missing behavioral detail rather than purely a virtue.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so some return-value explanation in the description would help, and no annotations to cover behavior. For a one-parameter tool this is minimally adequate but leaves open how the docs are delivered.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter has 100% schema description coverage ("OpenAPI JSON/path"), so the schema already documents it. The description adds no detail such as accepted formats or relative-vs-absolute path behavior, matching the baseline of 3 for fully covered schemas.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb+resource pair ("Generate markdown docs") and the input source ("from OpenAPI JSON"), which implicitly separates it from apidoc_from_routes. It does not explicitly name or contrast the siblings, so it falls short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance and no mention of the sibling apidoc_from_routes, which takes routes instead of an OpenAPI spec. Only implied context (you must have an OpenAPI spec) is available.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

apidoc_from_routesC

Document routes listed as method path lines.

ParametersJSON Schema
NameRequiredDescriptionDefault
routesYesRoutes text

TDQS

C2.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full behavioral burden, yet it discloses nothing about what 'document' produces (returned text, written file), whether it mutates state, or any auth/rate constraints. For a generation tool with zero annotation coverage this is a substantial gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler. It is efficient, though its brevity shades into under-specification rather than true conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and no annotations, the description should explain what the tool returns and how it differs from apidoc_from_openapi; it does neither. For a low-complexity single-parameter tool this is still too thin to call it correctly with confidence.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with a single required 'routes' string, so the baseline is 3. The description's phrase 'method path lines' adds a small format hint beyond the schema's bare 'Routes text', but no syntax example or delimiter details are given.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The verb 'Document' plus the resource 'routes' gives a recognizable purpose, and 'method path lines' hints at the accepted input format. However, it never distinguishes this from the sibling apidoc_from_openapi, which appears to do the same job from a different source format, leaving the agent to infer the boundary.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus apidoc_from_openapi or apidoc_status, and no prerequisites or context are given. Usage is only implied by the tool name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

apidoc_statusB

Health check for API Documentation MCP.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

B3.1/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full disclosure burden. It does not say whether the call is read-only, what constitutes a healthy response, or what the check reports (liveness, version, dependencies), leaving behavior largely unspecified.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single short sentence with no filler, front-loaded with the essential purpose. Nothing is wasted, though the brevity comes at the cost of detail rather than being maximally informative.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-parameter health check this is minimally adequate, and no output schema exists to explain return values. The description could still state what a positive/negative result looks like, which is a real gap for an agent deciding how to interpret the call.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so per the rubric the baseline is 4. There is nothing extra to document beyond what the empty schema already conveys.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific purpose — a health check for the API Documentation MCP — which is a clear verb+resource. It is implicitly distinct from apidoc_from_openapi and apidoc_from_routes, though the description never names those siblings or contrasts itself with them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to call this versus the sibling generation tools, nor any preconditions. The intended use (verify the service is reachable) is only implied by the phrase 'health check'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

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

  1. 3 tool updatesv1.0.0
    • First observedapidoc_from_openapi
    • First observedapidoc_from_routes
    • First observedapidoc_status

TDQS

B3.4/5.0

Scored across 3 tools

Disambiguation5/5

The three tools have clearly distinct purposes: a health check, generating docs from OpenAPI JSON, and generating docs from route lines. The two generation tools are differentiated by their input formats, so an agent can reliably select the right one.

Naming Consistency5/5

All tools share the same apidoc_ prefix and snake_case style, making the pattern predictable. The minor semantic difference (status vs. from_*) does not undermine consistency.

Tool Count5/5

Three tools is a tight, focused set for a documentation-generation server, with each tool earning its place. No redundant or clearly missing tools appear at this scope.

Completeness4/5

The server covers health checking and two common documentation source types (OpenAPI JSON and route lines). It lacks features like validation or output customization, but these are minor gaps for a basic doc-generation utility.

Maintenance

ActivityMaintained
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers