Skip to main content
Glama
apimatic

APIMatic Validator MCP Server

Official
by apimatic

validate-openapi-using-apimatic

Validate OpenAPI 2.0 and 3.0 specifications in JSON or YAML format to ensure API documentation quality and compliance.

Instructions

Get validation summary for your OpenAPI spec using APIMatic

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
openApiFileYesThe OpenAPI file content as a string
isYamlYesWhether the OpenAPI file is in YAML format
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. While it indicates this is a validation operation (likely read-only and non-destructive), it doesn't specify whether this requires authentication, has rate limits, what format the 'validation summary' returns, or any error conditions. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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 extremely concise - a single sentence that directly states the tool's function without unnecessary words. It's front-loaded with the core purpose and efficiently communicates the essential information. Every word earns its place in this minimal description.

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

Completeness2/5

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

Given the tool's purpose (validation), lack of annotations, and absence of an output schema, the description is insufficiently complete. It doesn't explain what constitutes a 'validation summary', what validation checks APIMatic performs, what format the results come in, or any error handling. For a validation tool with no structured output documentation, this leaves too many unanswered questions.

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?

The description adds no parameter-specific information beyond what's already documented in the schema (which has 100% coverage). It doesn't explain the relationship between the two parameters, provide examples of valid OpenAPI content, or clarify what 'validation summary' means in the context of these inputs. With complete schema documentation, the baseline score of 3 is appropriate.

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?

The description clearly states the tool's purpose: 'Get validation summary for your OpenAPI spec using APIMatic'. It specifies the action ('Get validation summary'), the resource ('OpenAPI spec'), and the method ('using APIMatic'). However, with no sibling tools mentioned, it cannot demonstrate differentiation from alternatives, which prevents a perfect score of 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus other validation methods or tools. It lacks context about prerequisites, alternatives, or specific scenarios where this validation approach is preferred. Without any usage context or exclusions mentioned, it offers minimal practical guidance for an AI agent.

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/apimatic/apimatic-validator-mcp'

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