Skip to main content
Glama

check_api_drift

Read-only

Compare a collection's docs with the real traffic a tunnel captured (Pro/Team). Returns routes nobody documented, status codes with no example, response or request fields missing from every example (or with another type), undocumented query parameters, and documented fields that never appear. Each finding includes request_id of the newest request that shows it: pass it to save_captured_request to add it to the docs, or fix the docs with upsert_api_endpoint and add_api_example. Use it to find out what drifted after a code change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoHow many recent requests to compare (default 200, max 500).
tunnelYesSubdomain of the tunnel whose traffic to compare.
collection_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so no contradiction exists. The description adds useful behavioral context: it compares docs against captured traffic, lists the types of drift it reports, and notes that each finding includes a request_id for follow-up. It also mentions the Pro/Team restriction, which is beyond what annotations provide.

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?

The description is dense but efficient. It front-loads the core purpose, then lists finding types and suggested actions in a compact form. The length is justified by the tool's complexity and the absence of an output schema, though it could be slightly tightened.

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

Completeness4/5

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

With no output schema, the description carries the burden of explaining what the tool returns. It does so by listing the categories of findings and the request_id field. It also explains how to act on results. Minor omissions like result ordering or pagination are acceptable given the read-only analysis nature and existing annotations.

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 67%: limit and tunnel have descriptions, collection_id does not. The description maps to the parameters ('collection's docs' and 'tunnel captured') but adds little beyond the schema. collection_id is reasonably inferable from its name and the phrase 'a collection's docs', so no significant gap remains.

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 verb ('Compare') and resource ('a collection's docs' against tunnel traffic), then enumerates exactly what kinds of findings are returned. It is clearly distinguishable from siblings like list_requests or run_api_endpoint because it is focused on drift detection rather than fetching or executing anything.

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 use context: 'Use it to find out what drifted after a code change.' It also recommends concrete follow-up tools (save_captured_request, upsert_api_endpoint, add_api_example). It does not explicitly say when not to use this tool versus an alternative, but the context is strong enough to guide selection.

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.