Search Frappe documentation

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

With no annotations provided, the description carries the transparency burden. It adds useful behavioral context by explaining the return shape (page titles and paths) and the integration with get_frappe_doc. However, it doesn't explicitly state read-only behavior, describe failure modes, or address edge cases like empty results, so it's adequately but not richly transparent.

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 tight sentences, each serving a purpose: first states the core action, second explains the output and usage priority. No redundant content, perfectly front-loaded.

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 simple two-parameter search tool with sibling tool and no output schema, the description covers the essential context: what it does, what it returns, and how it fits into the workflow. It lacks only minor details like explicit read-only confirmation or error handling, which are arguably not necessary for a well-scoped search tool.

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% (both `query` and `limit` are well-described), so the baseline is 3. The description adds no additional parameter-level semantics beyond the schema, but it does contextually relate the output to the `query` parameter. That doesn't push it above baseline.

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 it 'Find Frappe framework documentation pages by keyword', specifying the verb and resource. It also differentiates itself from the sibling get_frappe_doc by noting it returns paths to pass to that tool, establishing its role as the search entry point.

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?

Explicitly instructs 'Use this first when you do not already know the exact path of the page you want,' giving a clear when-to-use directive and implying the alternative (get_frappe_doc) when the path is known.

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