Convert OpenAPI JSON specs into Markdown API documentation for clear, shareable developer reference.
Generate markdown docs from OpenAPI JSON.
| Name | Required | Description | Default |
|---|---|---|---|
| spec | Yes | OpenAPI JSON/path |
Changes observed during successful MCP inspections.
v1.0.0Does 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.
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.
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.
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.
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.
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.