query_resource

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering safety. Description adds the constraint on datastore_active, but lacks details on rate limits, error behavior, or pagination beyond limit/offset parameters.

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?

Very concise: a single sentence for purpose and constraint, then a labeled list of parameters. No unnecessary words, front-loaded with key information.

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?

Covers purpose, constraint, and parameter usage adequately. With output schema present, return values are not needed. Could mention error cases or resource existence checks, but not essential for standard 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 coverage is 0%, so description compensates well by explaining each parameter: resource_id format, filters as key-value pairs, fields as column list, sort string examples, limit range, and offset for pagination. Adds meaning beyond schema types and defaults.

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 verb 'query' and resource 'resource via CKAN Datastore API', with emphasis on 'remote, no download needed'. This distinguishes from siblings like download_resource, but lacks explicit differentiation from sql_query or preview_data.

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 constraint 'Only works for resources with datastore_active=True' provides a condition. However, no guidance on when to use this vs. alternatives like sql_query or preview_data, and no exclusions mentioned.

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