Skip to main content
Glama

OpenAPI spec summary: operations, auth and servers

openapi_summary
Read-only

Read an OpenAPI 3 or Swagger 2 document (JSON or YAML, up to 2 MB) from a URL and summarise it for an agent: title, version, description, servers, auth schemes, operation count by method, tags, which operations are paid (402 or x-payment-info) or deprecated, and up to 150 operations with method, path, summary and operationId. Use before calling an unfamiliar API, to pick an endpoint, or to compare APIs. Example: url=https://petstore3.swagger.io/api/v3/openapi.json. Price $0.01/call via x402 USDC or a card key (/credits), first 25 free; failed calls free. Reads or computes only and changes nothing; each call is charged, so repeats are not free.

Input Schema

NameRequiredDescriptionDefault
urlYesURL of the OpenAPI or Swagger document

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial context beyond the annotations: a 2 MB size limit, JSON-or-YAML acceptance, per-call pricing (first 25 free, failed calls free), and an explicit 'each call is charged, so repeats are not free' that explains the non-idempotent, costly nature of retries. Also restates the read-only/no-mutation guarantee consistently with readOnlyHint and destructiveHint=false.

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?

Front-loaded with the action and the returned fields, then usage, then an example, then commercial terms. The pricing/permission sentence is long but earns its place because it explains retry cost. Slightly dense as a single paragraph, but no filler.

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

Completeness5/5

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

No output schema exists, yet the description effectively specifies the return payload field-by-field, including the 150-operation truncation cap — the key detail an agent needs to avoid assuming a full listing. Coverage limit, auth/payment route, and safety profile are all present.

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?

Schema coverage is 100% and the single `url` parameter is documented there. The description still contributes format and constraint meaning ('JSON or YAML, up to 2 MB' and a concrete example value) that the schema does not carry, though it does not say what happens for non-OpenAPI URLs or unreachable hosts.

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

Purpose5/5

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

States a specific verb ('Read ... and summarise') and resource (OpenAPI 3 / Swagger 2 document), then enumerates the exact fields returned (title, version, servers, auth schemes, operation counts, paid/deprecated flags, up to 150 operations with method/path/summary/operationId). No sibling tool does this, and the scope is unmistakable.

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

Usage Guidelines4/5

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

Gives concrete trigger conditions: 'Use before calling an unfamiliar API, to pick an endpoint, or to compare APIs', plus a worked example URL. It stops short of naming when NOT to use it or a specific alternative, but no sibling overlaps meaningfully.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.