Skip to main content
Glama

OpenAPI linter (agent readiness)

openapi_lint
Read-onlyIdempotent

Lint an OpenAPI/Swagger JSON or YAML: operationIds, descriptions, responses, undeclared path params, missing security schemes, servers, x402 payment info. Free: 10 calls/day; then $0.003 via the HTTP endpoint or X-API-Key credits.

Input Schema

NameRequiredDescriptionDefault
urlNospec URL
specNoor the spec (JSON object or YAML string)

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds genuinely non-structured context: a free tier of 10 calls/day, then $0.003 per call via the HTTP endpoint or X-API-Key credits — exactly the cost/auth constraint an agent needs before calling. It stops short of describing failure modes (e.g., invalid URL, unreachable spec).

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?

Two sentences, front-loaded with the resource and the check list, with cost/limit information trailing. The enumeration of checks is long but each item is a real capability, so it earns its space; nothing is redundant with the title.

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

Completeness3/5

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

An output schema exists, so return values need not be explained, and annotations cover safety. What remains missing for a two-parameter tool is the url/spec selection rule and any mention of failure behavior for unreachable or malformed specs — the one thing an agent could plausibly get wrong when invoking it.

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%, so the baseline is 3; the schema already labels 'url' as a spec URL and 'spec' as a JSON object or YAML string. The description does not clarify the important relationship between them — required is empty, and the phrase 'or the spec' hints at mutual exclusivity but never states that exactly one must be supplied or what happens if both or neither are given.

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?

States a specific verb (lint) and resource (OpenAPI/Swagger JSON or YAML) and enumerates the actual checks performed: operationIds, descriptions, responses, undeclared path params, security schemes, servers, x402 payment info. That is concrete enough to distinguish it from generic validators, though it never names near-siblings like json_schema_validate or mcp_tools_lint to route the agent explicitly.

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: you call it on an OpenAPI/Swagger document. There is no statement of when to prefer it over json_schema_validate, llms_txt_validate, or a2a_card_validate, and no guidance on choosing the url path versus pasting a spec inline. The pricing sentence is cost information, not when-to-use guidance.

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