Skip to main content
Glama

openapi_lint

Lint OpenAPI specs for agent readiness by checking version, operation IDs, parameter schemas, responses, and JSON examples, then return a readiness score with actionable issues.

Instructions

OpenAPI linter for agent readiness: version, info, servers, operationId presence/uniqueness/LLM-safe names, summaries, parameter schemas and descriptions, path placeholders, success and error responses, JSON examples. Returns an agent-readiness score and actionable issues. Costs 0.002 USDC on Base per successful call (x402). Without a payment key this tool returns the 402 challenge.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "openapi_lint"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoSpec URL
specNoInline spec (POST)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A3.9/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 on the non-obvious parts: it discloses a per-successful-call cost of 0.002 USDC on Base via x402, and that the call returns a 402 challenge when no payment key is present. It also states the response contains a score plus issues. It does not cover idempotence, rate limits, or whether a failed lint is still billed.

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 core purpose, and the payment/402 warning is properly placed at the end as a caveat. The long checklist is dense but each item is a concrete check type that helps an agent predict results; minor redundancy with 'agent readiness' appearing twice.

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?

No output schema exists, and the description compensates by stating what is returned (agent-readiness score and actionable issues). Combined with full schema coverage and the explicit payment prerequisite, an agent has enough to call it correctly; only mutual-exclusivity of url/spec is unexplained.

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 coverage is 100% and both parameters already carry descriptions ('Spec URL', 'Inline spec (POST)'), so the schema does the heavy lifting. The prose adds only the parenthetical POST hint already present in the schema and gives no guidance on precedence when both url and spec are supplied, or what happens if neither is.

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 ('OpenAPI linter') and then enumerates the exact classes of checks performed (versions, operationIds, LLM-safe names, parameter schemas, responses, JSON examples). This is materially distinguishable from siblings like mcp_manifest_lint or json_schema_validate, which lint different artifacts.

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?

Usage is only implied: an agent can infer it should call this to audit an OpenAPI spec for agent readiness, and the payment note implies a prerequisite. There is no explicit when-to-use vs. an alternative (e.g., openapi_to_mcp or mcp_manifest_lint) and no stated exclusions or preconditions beyond payment.

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