Skip to main content
Glama

Analyze API spec (preview)

analyze_spec

Parse an OpenAPI or Postman spec and preview the MCP tools it would generate without writing files, so you can filter and inspect operations before scaffolding.

Instructions

Parse an OpenAPI or Postman spec and preview the MCP tools that would be generated, without writing any files. Use this to curate (filter/inspect) before generating.

Input Schema

NameRequiredDescriptionDefault
specNoInline spec text (OpenAPI or Postman; JSON or YAML).
formatNoForce a format; defaults to auto-detect.
methodsNoKeep only these HTTP methods, e.g. [GET, POST].
pathGlobNoKeep only matching paths, e.g. "/v1/**".
specPathNoPath to a local spec file (JSON or YAML).
includeTagsNoKeep only operations with these tags.
excludeOperationsNoDrop operations by operationId, tool name, or tag.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.1

TDQS

A4.2/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 it delivers the single most important trait: this is a read-only preview that writes no files, which is exactly the side-effect information an agent needs before calling. It still omits auth/credential needs and error behavior on invalid specs, keeping it below 5.

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 sentences, no filler, and the core guarantee ('without writing any files') plus the intended use are front-loaded before any elaboration.

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 7-param, all-optional tool with no output schema and no annotations, the description covers purpose, the non-destructive guarantee, and the intended workflow. It would be stronger if it sketched the preview's return shape, since no output schema exists to do so.

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 description coverage is 100% and all 7 parameters carry inline descriptions, so the schema does the heavy lifting. The description only hints at filtering via 'curate (filter/inspect)' without adding syntax or semantics beyond what the schema already documents.

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 ('Parse') plus resource ('OpenAPI or Postman spec') and the output ('preview the MCP tools that would be generated'). The clause 'without writing any files' implicitly distinguishes it from generate_mcp_server, so an agent can route correctly without opening either schema.

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?

'Use this to curate (filter/inspect) before generating' gives a clear usage context and implies the workflow with generate_mcp_server. It does not name the alternative explicitly or state exclusions, so it stops short of a 5.

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