Skip to main content
Glama

Get an endpoint's OpenAPI definition

get_openapi_operation
Read-only

Returns the OpenAPI 3.1 definition of one REST endpoint, with the schemas it references, to generate a typed client from. Free, and works without logging in.

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": {
      "path": "<path>"
    },
    "name": "get_openapi_operation"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesThe endpoint's path under /v1.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true, so the read-only nature is covered; the description adds genuinely new operational facts — that access is free and requires no authentication — plus that referenced schemas are bundled into the response. It does not cover caching, versioning stability, or response size, keeping it out of the 5 band.

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?

A single tight sentence that front-loads the return value, then the payload contents, then the reason to use it, and closes with access terms. Every clause carries information; nothing is redundant.

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 one-parameter read tool with no output schema, the description tells the agent what comes back (an OpenAPI 3.1 document including referenced schemas), which is the key missing structured information. Minor gaps remain around whether the spec is stable or versioned, but nothing essential to invoking it is absent.

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 the single path parameter is already constrained by a complete enum with a description ("The endpoint's path under /v1"). The description only says "one REST endpoint" and adds no format, case, or selection guidance beyond the schema, so the baseline 3 is appropriate.

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?

The description uses a specific verb and resource ("Returns the OpenAPI 3.1 definition of one REST endpoint") and adds the intent behind the resource ("to generate a typed client from"), which distinguishes it from the behavioral sibling tools like cfdi_verify or rfc_validate even though none are named.

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?

It gives clear context for when to reach for this tool (client code generation) rather than making live calls against the individual endpoints. It stops short of naming an alternative or stating when not to use it, so it lands just below the top band.

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.

Resources