Skip to main content
Glama

api-diff-monitor

detect_breaking_changes

Check if a registered endpoint has had any breaking changes (removed fields or type changes).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endpoint_idYesEndpoint ID

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changed
    • changedInput schema / properties / endpoint_id / description
      Previous value: -"엔드포인트 ID"New value: +"Endpoint ID"
  2. First observed

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are provided, so the description must disclose behavioral traits. It only defines breaking changes but does not mention whether the operation is read-only, what happens if the endpoint does not exist, or what the return value looks like. The description implies a non-mutating check but does not explicitly confirm safety or side effects.

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, focused sentence that defines the tool's purpose and even clarifies what counts as a breaking change. There is no waste or redundancy, making it highly concise and appropriately structured.

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?

For a simple one-parameter tool with no output schema and no annotations, the description provides a decent baseline but lacks details on the comparison baseline (e.g., against what?) and edge-case behavior. It is minimally complete but leaves some contextual gaps that an agent might need to infer.

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 input schema has 100% description coverage for the single parameter endpoint_id, with a basic description 'Endpoint ID'. The tool description adds no additional meaning or constraints beyond the schema, so 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.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific action ('Check') on a specific resource ('a registered endpoint') and defines the scope as 'breaking changes (removed fields or type changes)'. This distinguishes it from sibling tools like compare_snapshots or get_diff_history, which focus on different aspects of endpoint monitoring.

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 implies the tool is used for checking registered endpoints but provides no explicit guidance on when to use this tool versus alternatives like compare_snapshots or get_diff_history. There are no when-to-use or when-not-to-use instructions, leaving the decision to the agent.

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.

TDQS

A4/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: CRUD operations for endpoints (register, list, delete) are separate from diff analysis (compare_snapshots, detect_breaking_changes, get_diff_history). Even the two diff-related tools differ in focus: compare_snapshots detects any changes, while detect_breaking_changes specifically flags breaking changes.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g., register_endpoint, list_monitored_endpoints, detect_breaking_changes). Verbs are specific and the pattern is predictable throughout.

Tool Count5/5

Six tools is well-scoped for an API diff monitoring server. Each tool covers a distinct aspect of the domain without redundancy, and the count is within the ideal range for coherence.

Completeness4/5

The tool set covers the core lifecycle of endpoints (register, list, delete) and the primary diff operations (compare, detect breaking, view history). Minor gaps like updating an endpoint or manually triggering a snapshot exist, but the inline comparison option in compare_snapshots provides a workaround for testing changes.

Resources