Search text (BM25)

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

Beyond the annotations (readOnlyHint=true, destructiveHint=false), the description adds critical behavioral context: requires `datacron index` to have been run first, demotes superseded notes by default, and explains the include_superseded flag. It also discloses the output format (ranked sandbox-wrapped snippets with term highlighting). This goes well beyond what annotations alone provide.

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 four sentences, front-loaded with the key usage directive ('First stop...'), and every sentence adds value. No redundant or filler content.

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 is complete for a search tool: it covers the prerequisite (indexing), default behavior (superseded demotion), a key option (include_superseded), and output characteristics. An output schema exists to formalize the return structure, so detailed return values don't need to be in the description. It also provides enough context to differentiate from sibling search tools.

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 0%, so the description carries the burden. It explains include_superseded and its default behavior, but does not explain `query` or `limit` beyond their existence in the schema. Since `query` is self-explanatory and `limit` has an obvious default, partial compensation is present, but it's not complete.

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 clearly states it performs full-text BM25 search over the user's notes, with a specific verb (search) and resource (FTS5 index). It also positions itself as the 'first stop' for questions, distinguishing it from siblings like search_regex by emphasizing it as the default search tool.

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 clear when-to-use guidance ('First stop for any question... search before saying you do not know'), indicating it should be the initial tool. However, it does not explicitly mention alternatives such as search_regex or specify when not to use it, so it lacks explicit exclusions.

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