query

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

With no annotations, the description carries the full burden. It adds valuable behavioral context: BaseQL uses Float instead of Int, '_page_size/_page' for pagination, and unquoted keys in filters. This goes beyond a generic 'query' description, though it does not specify read-only or potential mutation behavior, which is a minor gap.

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 three concise sentences that front-load the purpose, then provide usage guidance and key conventions. Every sentence earns its place with no redundant or filler content.

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?

For a complex custom query tool with no output schema, the description and parameter schema together cover purpose, when to use, syntax examples, pagination, and linked records. It lacks explicit mention of read-only vs. mutation capabilities and does not explain error handling, but overall it is fairly complete for a query 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 baseline is 3. The description adds meaning beyond schema by explaining BaseQL conventions (Float, pagination, filter syntax) that directly affect how to construct the 'query' parameter. This contextual guidance enhances the parameter descriptions already present in the 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 tool executes custom GraphQL queries against BaseQL, and directly distinguishes it from siblings by mentioning 'complex queries, joins across tables' and 'when other tools don't meet your needs.' This is a specific verb+resource with explicit differentiation.

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?

It provides clear when-to-use guidance: 'Use this for complex queries, joins across tables, or when other tools don't meet your needs.' It does not explicitly name alternative tools, but the sibling list is present and the phrase 'other tools' implies exclusion. The syntax tips further guide usage.

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