Xray Graphql Query

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

Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description repeats the read-only nature and adds the important operational rule that lists require a limit of at most 100, but it does not describe auth needs, rate limits, or error 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?

Two short sentences with no filler. The read-only restriction is front-loaded, followed immediately by the two most useful query-construction constraints.

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?

An output schema exists, so return values need not be explained, and annotations cover the safety profile. The description supplies the key query-construction constraints, but it does not clarify when to use this over xray_graphql_schema or xray_graphql_mutation, which would make it fully complete for a complex GraphQL 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%, so the schema already documents both parameters, setting a baseline of 3. The description goes beyond the schema by specifying that entities are addressed by issue id and that every list needs a limit of max 100, which are concrete constraints for building the query parameter.

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?

States a specific verb and resource: run a read-only Xray GraphQL query. It distinguishes itself from the sibling xray_graphql_mutation via 'read-only' and the schema's 'no mutations' constraint, so an agent can identify its role immediately.

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 by saying it is read-only and by enforcing 'every list needs limit (max 100)', which helps construct a valid query. However, it does not explicitly say when to prefer this tool over xray_graphql_schema or xray_graphql_mutation, leaving alternatives to inference.

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