xray_graphql

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. It adds the cloud-deployment restriction but does not state whether mutations are allowed, how auth works, what errors or response shape to expect, or any rate limits. This is a significant gap for an arbitrary GraphQL executor.

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?

The description is two sentences with the action and constraint front-loaded, followed by concrete usage examples. Every word earns its place and there is no redundancy.

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 description covers purpose, usage, and a critical environment constraint (cloud-only), but given the tool's complexity, no output schema, and no annotations, it omits important behavioral details such as response format, error handling, and mutation safety. It is adequate for selection but not fully complete.

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 description coverage is 100%, so the schema already documents both parameters. The description adds context about intended query content but not additional parameter-level syntax or variable formatting; baseline 3 is appropriate.

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 states a specific verb ('Executes') and resource ('GraphQL query against Xray Cloud'), then lists concrete use cases (test runs, test steps, preconditions, test sets). This clearly distinguishes it from sibling tools, which target specific Xray endpoints or operations.

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?

Provides explicit instruction: 'Use this for advanced Xray-specific queries like...' which tells when to choose this tool. However, it does not explicitly state when not to use it or mention alternatives like the sibling CRUD tools, so it lacks full exclusions.

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