@mcpx-digital/openapi-summarize

generate_cheat_sheet

Create a concise markdown API cheat sheet from a local OpenAPI/Swagger file to give agents quick endpoint reference without remote fetching.

Instructions

Generate a short agent-friendly markdown API cheat sheet from a local OpenAPI file. Reads a local OpenAPI/Swagger JSON or YAML file path only — does not fetch remote specs.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "filePath": "<filePath>"
    },
    "name": "generate_cheat_sheet"
  }
}

Input Schema

Name	Required	Description	Default
`maxOps`	No	Max operations to include (default 80, max 500).
`filePath`	Yes	Path to OpenAPI JSON/YAML.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Sep 13, 2026

TDQS

A3.6/5.0

Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses that only local JSON/YAML files are read and no network fetch occurs, but says nothing about what happens on an unreadable or malformed spec, whether output is written to disk or returned inline, or any truncation behavior tied to maxOps.

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

Conciseness5/5

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

Two tight sentences, front-loaded with the purpose and followed by the single most important constraint. No filler or redundancy.

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

Completeness4/5

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

For a simple two-parameter read tool with no annotations and no output schema, the description covers what the tool produces (markdown cheat sheet) and its input constraint. It could say a bit more about output shape or failure modes, but nothing essential to invoking it is missing.

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%, so both filePath and maxOps are already documented with defaults and limits. The description reinforces that filePath must be local (not a URL), which adds slight value, but contributes nothing about maxOps beyond the schema. Baseline 3 applies.

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 verb (generate) and a concrete artifact (a short agent-friendly markdown API cheat sheet) derived from a local OpenAPI file. The scope is unambiguous, though it never contrasts itself with siblings like summarize_by_tag or find_missing_auth, so an agent must infer the distinction from the resource alone.

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

Usage Guidelines3/5

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

It gives one clear boundary — local file paths only, remote specs are not fetched — which functions as a 'when-not'. However, it never says when to choose this over summarize_by_tag/find_missing_auth/list_deprecated, and gives no prerequisites such as valid spec format or file accessibility.

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

Deploy Server