Skip to main content
Glama
kardaj

openapi-tools-mcp

by kardaj

Spec Info

spec_info

Summarize an OpenAPI specification from a local path or URL source object, with optional headers for remote specs.

Instructions

Quickly summarize an OpenAPI spec from a local path string or URL source object. For remote specs, pass {"url": "https://example.com/openapi.yaml", "headers": {"Header-Name": "value"}}; headers are optional, only http/https URLs are supported, and successful downloads are cached in memory for 15 minutes with stale fallback on network errors or HTTP 5XX refresh failures.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spec_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the 15-minute in-memory cache, stale fallback on network errors and HTTP 5XX refresh failures, http/https-only URL support, and that headers are optional. It does not mention authentication or rate limits, but the caching/fallback behavior is genuinely useful operational context.

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?

Two sentences, front-loaded with the core action before the remote-spec handling details. The second sentence is dense with several facts, but every clause (cache duration, fallback conditions, scheme restriction) carries information and none is wasted.

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?

An output schema exists, so return values need not be explained, and the description adequately covers both input forms plus caching/error behavior. For a one-parameter tool this is close to complete; only sibling routing guidance is missing.

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 schema has 0% description coverage and only declares spec_path as anyOf string|object with no field detail. The description compensates by spelling out the object form ({url, headers}) and clarifying that headers are optional, which the schema alone would leave ambiguous.

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 ('summarize') and resource ('an OpenAPI spec'), which distinguishes it from sibling spec_get (retrieve raw) and spec_list (enumerate). However, it never explicitly contrasts itself with those siblings, so the differentiation is inferred from the verb rather than stated.

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 explains how to use the tool for remote specs (the {url, headers} form) but gives no explicit guidance on when to pick this over spec_get or spec_list. Usage is implied by 'summarize' rather than declared.

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

Deploy Server

Other Tools