openapi_diff
Compare two OpenAPI specs and flag breaking vs non-breaking API changes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| new | Yes | New OpenAPI JSON/YAML | |
| old | Yes | Previous OpenAPI JSON/YAML |
Compare two OpenAPI specs and flag breaking vs non-breaking API changes.
| Name | Required | Description | Default |
|---|---|---|---|
| new | Yes | New OpenAPI JSON/YAML | |
| old | Yes | Previous OpenAPI JSON/YAML |
Changes observed during successful MCP inspections. Dates show when Glama detected each change.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden. It adds the key detail of breaking vs non-breaking classification, which is non-obvious. However, it does not disclose how results are returned (e.g., list, summary, diff object) or error handling behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, concise sentence of 12 words that conveys the core functionality without any fluff. It is well-structured and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool lacks an output schema and the description does not clarify what 'flag' means (e.g., return list, diff object, status). Given the complexity of diffing OpenAPI specs, more details about the output format are needed for the agent to use it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with clear parameter descriptions for 'old' and 'new'. The tool description restates these as 'two OpenAPI specs' but adds no additional semantic value beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: compare two OpenAPI specs and classify changes as breaking or non-breaking. This distinguishes it from similar siblings like graphql_schema_diff or openapi_validate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage in API migration or review scenarios but does not explicitly state when to use it versus alternatives like openapi_validate or graphql_schema_diff. No when-not-to-use guidance is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Every tool has a clear, distinct purpose with thorough descriptions. Even closely related tools like base64_decode/encode and hash_md5/sha256 are easily differentiated by name and description.
All tools follow a consistent lowercase_underscore naming convention, typically in a <domain>_<action> or <action>_<domain> pattern. There are no jarring deviations or mixed styles.
193 tools is an extreme count, far beyond what any focused server needs. While each tool has utility, the sheer number creates a kitchen-sink effect that overwhelms agents and hinders discoverability.
Within each subdomain (JSON, cron, JWT, etc.), the coverage is exhaustive, covering validation, conversion, parsing, and more. Minor gaps exist (e.g., YAML-to-TOML conversion missing), but overall it is remarkably complete.