xql_lookups_get_data

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

The description discloses key behavioral constraints: maximum 10,000 entries returned, three-minute timeout, license requirements, and filter matching semantics (AND within a block, OR across blocks). This goes well beyond a basic operation description and adds value since no annotations are provided.

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 concise and front-loaded with the primary purpose. It uses a short paragraph plus bullet points for notes, making it easy to scan. Every sentence adds value without unnecessary verbosity.

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 the essential behavioral aspects: limits, timeout, filtering semantics, and license. There is no output schema, but the description is sufficient for an agent to select and invoke the tool. A minor gap is the lack of response format details, but overall it is complete for the tool's complexity.

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?

The description adds meaningful context for the 'filters' parameter by explaining the AND/OR block semantics and the behavior when no filters are specified. It also references the 10,000-entry limit relevant to the 'limit' parameter. While it does not explicitly name dataset_name or limit, the schema provides descriptions for those, and the description compensates for the critical filter logic.

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 'Get data from a lookup dataset' with a specific verb and resource, and the filtering semantics are precisely explained. It distinguishes itself from sibling tools like xql_lookups_add_data and xql_lookups_remove_data by focusing on retrieval.

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?

Implied usage is clear: this tool retrieves data from lookup datasets with optional filters. It explains filtering behavior and defaults, but it does not explicitly mention when to prefer it over alternatives like xql_query or provide exclusions. The context is still clear.

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