Skip to main content
Glama

OpenAPI Diff

diff_openapi

Détecte les nouvelles exigences de requête par opération dans deux contrats OpenAPI 3.x au format JSON.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "avant": "<avant>",
      "apres": "<apres>"
    },
    "name": "diff_openapi"
  }
}

Input Schema

NameRequiredDescriptionDefault
apresYes
avantYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full burden. It does not state that the operation is read-only, does not say whether 'avant' is the baseline compared against 'apres', does not define what qualifies as a 'new' requirement, and gives no hint of the result shape — significant gaps for a comparison tool with no output schema.

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 with no filler or redundancy. It is efficient, though its brevity is partly the cause of the semantic gaps rather than a virtue in itself.

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 diff tool taking two opaque nested objects with no annotations and no output schema, the description should define the baseline/target roles and the nature of the returned differences. Neither is covered, leaving the agent unable to predict the call's effect or result.

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 0%: both 'avant' and 'apres' are untyped objects with no descriptions. The sentence only implies that the two parameters are the two contracts; it never maps them, never specifies the expected OpenAPI version beyond '3.x', and never says what object structure is acceptable.

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?

States a specific verb and resource: detects new request requirements per operation across two OpenAPI 3.x JSON contracts. The purpose is recognizable without opening the schema, though 'nouvelles exigences de requête' remains ambiguous — it does not say whether this means required fields, new parameters, or request-body schema changes.

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?

No when-to-use guidance, no prerequisites, and no statement of what the tool is not for. There are no sibling tools to differentiate from, but the definition still gives the agent no condition under which this diff is the right call versus a generic contract comparison.

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.

Resources