Skip to main content
Glama

IA-QA — 152 QA & Dev Tools for AI Agents

openapi_validate

Read-onlyIdempotent

Validate the structure of an OpenAPI 3.x specification (JSON or YAML). Checks required top-level fields (openapi, info.title, info.version, paths), validates each operation (responses, operationId uniqueness), detects undeclared $ref components, and flags missing 2xx responses. Returns a PASS/FAIL verdict, a 0–100 compliance score, and a list of errors and warnings with JSON-pointer locations. Use before publishing an API spec or generating SDK code.

Input Schema

NameRequiredDescriptionDefault
inputYesThe OpenAPI 3.x spec — a JSON string, a YAML string, or the already-parsed spec object.

Output Schema

NameRequiredDescriptionDefault
scoreNo
statsNo
errorsNo
verdictNo
warningsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "input": {
      +      "info": {
      +        "title": "t",
      +        "version": "1"
      +      },
      +      "openapi": "3.0.3",
      +      "paths": {
      +        "/a": {
      +          "get": {
      +            "operationId": "getA",
      +            "responses": {
      +              "200": {
      +                "description": "ok"
      +              }
      +            }
      +          }
      +        }
      +      }
      +    }
      +  }
      +]
  2. Changed2 schema fields changed
    • changedInput schema / properties / input / description
      Previous value: -"OpenAPI 3.x specification as a JSON or YAML string"New value: +"The OpenAPI 3.x spec — a JSON string, a YAML string, or the already-parsed spec object."
    • changedInput schema / properties / input / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "object",
      +  "array"
      +]
  3. Changed1 schema field changed
    • addedOutput schema / properties
      Added value: +{
      +  "errors": {},
      +  "score": {
      +    "type": "number"
      +  },
      +  "stats": {
      +    "type": "object"
      +  },
      +  "verdict": {},
      +  "warnings": {}
      +}
  4. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "type": "object"
      +}
  5. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, non-destructive, and closed-world behavior, so the safety profile is covered. The description adds useful substance beyond that: the exact validation rules applied and the return shape (PASS/FAIL verdict, 0–100 score, errors/warnings with JSON-pointer locations). Minor gap: it doesn't say whether validation stops at the first failure or reports all issues.

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?

Three sentences, front-loaded with the core action and followed by the concrete checks, the return shape, and the use case. Every sentence contributes and nothing is redundant.

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?

The tool is a stateless single-input validator with a 100%-documented parameter and an output schema; the description covers what is validated, what is returned at a high level, and when to invoke it. Nothing an agent needs to call it correctly is missing.

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 the single parameter's schema description already states it accepts a JSON string, YAML string, or parsed object. The description adds no parameter-level detail beyond that, so the baseline of 3 applies.

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?

The description opens with a specific verb and resource ('Validate the structure of an OpenAPI 3.x specification') and then enumerates exactly what is checked: required top-level fields, per-operation validation, undeclared $ref components, and missing 2xx responses. An agent can distinguish this from the sibling json_schema_validate purely on the OpenAPI-specific rule set.

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 a clear usage context: 'Use before publishing an API spec or generating SDK code.' That tells the agent when this tool is appropriate, but it names no exclusions or alternatives (e.g., json_schema_validate) for non-OpenAPI schema checking.

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.