introspect-schema

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

No annotations provided, but description declares 'READ-ONLY: Non-destructive metadata discovery' and explains output types (SDL vs Manifest). Missing details on potential errors or pagination, but adequate for a read-only introspection tool.

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?

Well-structured with numbered steps, but slightly verbose. Each sentence adds value; could be slightly tighter but still effective.

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?

Given 2 parameters, no output schema, no annotations, description covers modes, return types, and purpose. Lacks error handling details, but sufficient for an introspection tool.

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 descriptions. Description adds crucial meaning: typeNames triggers SDL mode, omission gives manifest; also notes typeDepth default of 2.

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 'Retrieve GraphQL schema details or system manifest' and distinguishes two modes: with typeNames returns SDL, without returns Federated Manifest. This differentiates from sibling tool 'query-graphql', which executes queries.

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?

Explicit usage guidance: 'If 'typeNames' is provided... If 'typeNames' is omitted... Use this to navigate the federated graph topology before executing queries.' Tells when to use each mode and context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.