graphql_schema_diff
Diff two GraphQL schemas for removed types/fields (breaking changes).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| new | Yes | ||
| old | Yes |
Diff two GraphQL schemas for removed types/fields (breaking changes).
| Name | Required | Description | Default |
|---|---|---|---|
| new | Yes | ||
| old | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, description notes focus on breaking changes (removals) but does not clarify if it detects other changes, output format, error handling, or behavior with invalid schemas.
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?
Single sentence, 11 words, front-loaded purpose. No unnecessary words.
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?
No output schema and no description of return format. For a diff tool, missing output details (text, object, list of changes) is a significant gap. No annotations to compensate.
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 has 'old' and 'new' with no descriptions; description implies they are schemas but does not specify format (string, file, URL) or provide examples. Schema coverage 0%, minimal added value.
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?
Description clearly states verb 'diff', specific resource ('two GraphQL schemas'), and purpose ('removed types/fields (breaking changes)'). Distinguishes from siblings like graphql_validate and graphql_operations_list.
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?
Implies usage when comparing GraphQL schemas for breaking changes, but no explicit guidance on when to use vs alternatives, prerequisites, or exclusion cases.
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.