query-graphql-master

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

With no annotations provided, the description carries full burden but lacks behavioral details. It doesn't disclose whether this is a read-only query, if it requires authentication, potential rate limits, or what the response format might be. For a GraphQL query tool, this omission is significant as it leaves the agent unaware of operational constraints.

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 a single, efficient sentence with no wasted words. It front-loads the core action and target, making it easy to parse quickly.

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 the complexity of GraphQL queries, lack of annotations, no output schema, and low schema description coverage, the description is incomplete. It fails to address key aspects like authentication needs, error handling, or response structure, which are crucial for effective tool use.

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 0%, so the description must compensate but only partially does. It mentions 'query' and 'variables' parameters, aligning with the schema, but doesn't explain their semantics (e.g., that 'query' is a GraphQL query string, 'variables' is optional JSON). This adds minimal value beyond the bare 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 action ('Query') and target ('a Sitecore GraphQL master endpoint'), making the purpose understandable. However, it doesn't distinguish this tool from its sibling 'query-graphql-web' or 'introspection-graphql-master', which appear to serve similar GraphQL query purposes but target different endpoints or provide introspection.

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?

No guidance is provided on when to use this tool versus alternatives like 'query-graphql-web' or 'introspection-graphql-master'. The description only states what it does without context on appropriate scenarios or prerequisites, leaving the agent to infer usage.

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