Skip to main content
Glama

docs_validate_spec

Validate OpenAPI specifications to detect errors, warnings, and best practice violations. Ensure API quality with strict validation and detailed feedback.

Instructions

Validate an OpenAPI specification for errors, warnings, and best practice violations (Pro)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
strictNoEnable strict validation mode
api_keyNoAPI key for authentication
openapi_specYesOpenAPI specification in JSON or YAML format
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It clearly discloses the validation scope and implicitly signals a read-only check, but it does not explicitly state that the tool does not modify the spec, does not mention authentication requirements (despite the api_key parameter), and does not address rate limits or side effects. The '(Pro)' tag hints at access limitations but is not explained.

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?

The description is a single, front-loaded sentence with no filler. Every word contributes to the core purpose of the tool. The parenthetical '(Pro)' is the only slight add-on but is not distracting.

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?

With no output schema and no annotations, the description should clarify what the agent will receive after a call. The mention of 'errors, warnings, and best practice violations' implies a report, but it does not explicitly state the return format, whether the operation is synchronous, or how errors are presented. The required parameter and api_key are left to the schema, and there is no practical guidance on interpreting results.

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 description adds no parameter-specific meaning beyond the schema; it does not clarify how 'strict' changes validation behavior, when 'api_key' is required, or what format 'openapi_spec' should take. The parameters are sufficiently described in the schema, but the description does not enrich them.

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 states a specific action ('Validate'), a clear resource ('an OpenAPI specification'), and the exact focus of the validation ('errors, warnings, and best practice violations'). This distinguishes it from sibling tools like docs_generate_openapi or openapi_generate_client, which are about generation rather than validation.

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?

The verb 'Validate' implies the use case: checking an existing OpenAPI spec for issues. However, there is no explicit guidance about when to use this tool versus alternatives, no mention of exclusions, and no information about prerequisites like whether the spec must be valid JSON/YAML or whether the Pro designation imposes usage requirements.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/barnburner121/claude-plugin-marketplace'

If you have feedback or need assistance with the MCP directory API, please join our Discord server