Skip to main content
Glama

api_contract_test

Verify API contract compatibility between provider OpenAPI spec and consumer expectations to prevent integration issues.

Instructions

Verify API contract compatibility between a provider spec and consumer expectations (Pro feature)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyNo
consumer_specYesPath to consumer expectations (OpenAPI or Pact file)
provider_specYesPath to provider OpenAPI spec
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. It doesn't state whether the verification reads local files, makes network calls, requires the api_key parameter, what happens on mismatch, or whether any files are written. The '(Pro feature)' note is the only behavioral hint, suggesting gating or payment requirements, but nothing about side effects or failure modes.

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?

A single, front-loaded sentence that gets to the point quickly with zero filler. The verb comes first and the scope is immediately clear. It earns its place, though it's arguably too brief to carry the behavioral context this tool needs.

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?

For a 3-parameter tool with no annotations and no output schema, this description is thin. It doesn't mention expected inputs beyond the vague spec references, doesn't describe the verification result/return format, and doesn't address the api_key requirement implied by the Pro feature note. An agent would lack critical information to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 67%, with provider_spec and consumer_spec already documented in the schema. The description loosely echoes those params ('provider spec', 'consumer expectations') but adds no new meaning beyond what the schema states. It notably fails to clarify the undocumented api_key parameter, which an agent would need to understand before calling the tool.

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 uses a specific verb ('Verify') and names a clear resource: API contract compatibility between a provider spec and consumer expectations. It conveys the tool's function effectively. However, it doesn't explicitly distinguish itself from siblings like docs_validate_spec or api_generate_tests, which also deal with API specs.

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 gives no guidance on when to use this tool versus alternatives, no prerequisites, and no exclusions. The '(Pro feature)' parenthetical hints at access requirements but doesn't say when an agent should choose this over related API tools. An agent is left to infer the use case from the tool name alone.

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