search_kb_pages

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

No annotations are provided, so the description carries full burden. It states the tool returns matching pages with titles, spaces, and URLs, implying a read operation. However, it does not disclose pagination behavior, rate limits, or potential side effects. The parameter descriptions (e.g., maxResults) hint at pagination but lack explicit behavioral details.

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?

Two sentences cover purpose, modalities, and return format. Front-loaded and concise with no redundant 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?

For a search tool with 4 parameters and no output schema, the description and schema together provide sufficient context. However, it lacks details on result ordering or partial retrieval beyond maxResults, which is a minor gap.

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 100%, so baseline is 3. The description adds value by stating that results include 'titles, spaces, and URLs', which compensates for the lack of an output schema. This clarifies what the tool returns beyond the input parameters.

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 searches for Confluence/KB pages using text, title, or CQL query. It distinguishes from siblings like get_kb_page (single page) and search_tickets (different resource). The verb 'Search' and resource 'Confluence/KB pages' are specific.

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 mentions search modalities (text, title, CQL) but does not explicitly say when not to use it or direct to alternatives like get_kb_page for single page retrieval. The context of siblings implies usage, but explicit guidance is missing.

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