Skip to main content
Glama

lint

Check an OpenAPI spec for schemas no value can satisfy, such as arrays with scalar enums or oneOf with additionalProperties false. Find these defects before serving or deploying to prevent mock validation errors.

Instructions

Check an OpenAPI spec for schemas no value can satisfy, such as an array with a scalar enum or additionalProperties: false next to oneOf properties. Mockzilla can't generate valid responses for these, so requests to affected endpoints fail validation. Returns {clean, defect_count, defects: [{rule, path, detail}], truncated}; at most 50 defects are listed. Pass input as a local spec file or a public https URL. Use it before serving or deploying a spec, or when a mock returns unexpected validation errors. OpenAPI 3.x only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
inputYesSpec file path or public https URL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.20

TDQS

A4.3/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 largely succeeds: it discloses the return object structure, the 50-defect cap/truncation behavior, and the downstream consequence of unsatisfiable schemas. It does not explicitly state that the operation is non-mutating, but 'Check' and the return contract strongly imply a read-only analysis.

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?

Four dense sentences deliver the purpose, defect examples, return contract, parameter format, usage timing, and version constraint without filler. The purpose is front-loaded and every clause earns its place.

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?

For a single-parameter lint tool with no output schema, the description is complete: it covers the input type, return fields, result truncation, version restriction, and the situations that warrant calling it. Nothing essential to invoking the tool 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?

The schema already describes `input` fully as 'Spec file path or public https URL,' and the description only restates this. It adds no new syntax, resolution, or error-handling details beyond what the schema provides, so the baseline 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?

States a concrete action ('Check') on a concrete resource ('an OpenAPI spec') with a precise goal: find schemas no value can satisfy. Concrete examples like 'array with a scalar enum' and the 'OpenAPI 3.x only' constraint make the tool's role unambiguous among siblings.

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?

Explicitly tells the agent when to invoke it: before serving/deploying a spec or when a mock returns unexpected validation errors. It does not name alternatives or state exclusions, but the timing guidance is clear and actionable.

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