itglue_search_documents

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

With no annotations, the description carries the full burden. It discloses the case-sensitive substring limitation and the auto-retry with first-word and diacritic-stripped variants, including the meta.search_strategy reporting. However, it does not mention rate limits, auth needs, or response format details beyond the strategy.

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, front-loaded with the purpose, and each sentence adds distinct value. No fluff or 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?

Given 6 parameters, no output schema, and no annotations, the description covers the key behavioral trait (case-sensitivity + auto-retry). It misses explicit return structure, but the schema covers parameter details adequately. For a search tool, it's reasonably 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 coverage is 100%, so baseline is 3. The description adds context for the 'name' parameter by explaining IT Glue's case-sensitive substring behavior and fallback. This adds value beyond the schema, justifying a 4.

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 'Search IT Glue documents' with a specific verb and resource. It distinguishes itself from sibling tools like itglue_search_configurations by targeting documents. The additional details about case-sensitive substring matching further clarify the intended scope.

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?

The description implies usage for searching documents but provides no explicit guidance on when to use this tool versus alternatives, nor does it mention when not to use it. The auto-retry behavior is noted but not as a usage guideline.

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