Skip to main content
Glama

Resumir y revisar OpenAPI

openapi-summary
Read-onlyIdempotent

Resume un documento OpenAPI 3.x: título, versión, servidores, operaciones y problemas (sin operationId, sin respuestas, respuestas 402). Cuándo: hay que leer, convertir o revisar una descripción de agente, una lista de herramientas, un documento OpenAPI o un recibo según el formato de su protocolo. No para: traducir la descripción completa de un agente o API entre A2A, MCP, OpenAPI y x402 (onda-traducir). Efectos secundarios: ninguno (solo lectura, sin red, sin estado guardado). Determinista: la misma entrada da la misma salida. Límites: entrada JSON de hasta 64 KB, 1 s por llamada, resultado de hasta 1 MB.

EN: Summarizes a supplied OpenAPI 3.x document: title, version, servers, operations (method, path, operationId, summary), security, and lint issues (missing operationId/summary, no responses, 402 payment responses). When: an agent description, tool list, OpenAPI document or receipt has to be read, converted or checked against its protocol format. [EN completo / full EN: inputSchema.description]

Input Schema

NameRequiredDescriptionDefault
openapiYesOpenAPI document (JSON object) (object; required).

Output Schema

NameRequiredDescriptionDefault
titleNo
issuesNo
openapiNo
serversNo
versionNo
operationsNo
operation_countNo
security_schemesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / openapi / examples
      Added value: +[
      +  {
      +    "info": {
      +      "title": "Empty",
      +      "version": "0"
      +    },
      +    "openapi": "3.0.3",
      +    "paths": {}
      +  }
      +]
  2. Changed1 schema field changed
    • addedInput schema / description
      Added value: +"EN: Summarizes a supplied OpenAPI 3.x document: title, version, servers, operations (method, path, operationId, summary), security, and lint issues (missing operationId/summary, no responses, 402 payment responses). When: an agent description, tool list, OpenAPI document or receipt has to be read, converted or checked against its protocol format. Not for: translating a whole agent or API description between A2A, MCP, OpenAPI and x402 (onda-traducir). Side effects: none (read-only, no network access, no stored state). Deterministic: the same input gives the same output. Limits: JSON input up to 64 KB, 1 s per call, result up to 1 MB."
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so 'sin efectos secundarios (solo lectura, sin red, sin estado guardado)' largely restates structured data. However the description adds genuinely new operational facts: hard limits of 64 KB input, 1 s per call, 1 MB result, and a determinism guarantee — real value an agent cannot read off the annotations. It stops short of saying what happens with a malformed/non-3.x document.

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

Conciseness3/5

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

Well front-loaded — purpose first, then when/not-for/effects/limits — and the labeled structure is easy to scan. But the content is duplicated wholesale in Spanish and English, which roughly doubles the length without adding information, and 'resultado de hasta 1 MB' is a fact the output schema could carry. Efficient in shape, wasteful in volume.

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?

For a single-input read-only inspection tool with a full annotation set and an output schema, nothing an agent needs is missing: purpose, scope boundaries, sibling exclusion, cost/limits and determinism are all stated, and return values are covered by the output schema.

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?

Only one parameter, and schema coverage is 100% — the schema already documents it as a required JSON object with an example. The description adds the domain constraint 'OpenAPI 3.x' and the 64 KB size ceiling, but does not clarify 3.0 vs 3.1 acceptance or whether a raw string/YAML is accepted. Baseline 3 given the schema does the heavy lifting.

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+resource (summarize an OpenAPI 3.x document) and enumerates exactly what the summary contains: title, version, servers, operations (method, path, operationId, summary), security, and lint issues. It also names the sibling it is not (onda-traducir), so an agent can separate the two 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 Guidelines5/5

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

An explicit 'Cuándo' clause lists the triggering situations (reading/converting/checking an agent description, tool list, OpenAPI document or protocol receipt) and an explicit 'No para' clause routes translation work to onda-traducir. This is the when/when-not/alternative pattern at full strength, even if the 'when' list is broad.

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