wiki_search

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

No annotations provided, so description carries full burden. Discloses technical detail (SQLite FTS5 with prefix matching) and return format (title + snippet). However, does not mention read-only nature, rate limits, or permissions. Adequate but could be more comprehensive.

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?

Three sentences: purpose and scope, technical detail, usage guidance. Each sentence adds essential information with no redundancy. Efficient and well-organized.

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?

No output schema; description explains return values ('title + snippet') and covers assets searched. Does not detail pagination or ordering, but limit parameter is in schema. Sufficient for a search tool with good schema coverage.

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% with descriptions for all three parameters. Description adds context for 'q' by stating full-text search over wiki assets, but does not significantly enhance parameter understanding beyond schema. Baseline score of 3 is appropriate.

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 performs full-text search over specific wiki assets (flows, doc_pages, reviews, releases). It uses precise verb 'search' and lists the resource types, distinguishing it from sibling tools like 'wiki_get_page' or 'search'.

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?

Provides explicit when-to-use scenarios ('when the user asks what we know about X', 'to find relevant ADRs/Patterns/Runbooks before planning'). Does not mention when not to use or compare to alternatives like 'search', but gives clear context.

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