Search Bharosa API Documentation

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

Annotations already declare readOnlyHint=true, openWorldHint=false, idempotentHint=true, and destructiveHint=false, so the repeated claims that it 'only reads a local index' and 'can never read or write an account' largely restate structured data. The one genuinely additive point is that results are documentation text even for write endpoints, and that the method filter is a metadata match rather than an action — useful disambiguation beyond the annotations, though delivered redundantly.

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 purpose is front-loaded in a single clear sentence, but two of the three sentences are safety disclaimers that overlap each other and duplicate the annotations. The space would have been better spent on sibling differentiation or explaining the group filter.

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?

With an output schema present, return values need not be explained, and the read-only nature is fully covered. The remaining gap is guidance on the group parameter and on how this differs from sibling search tools, but for a simple 4-parameter read-only search the description is close to sufficient.

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 50%, with the query and method parameters documented in-schema. The description reinforces method as a documented-verb filter that never executes a request, which is meaningful disambiguation, but it says nothing about the group enum (resource/monthly) or the limit bounds, leaving half the parameters unaddressed.

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 first sentence gives a specific verb and resource: 'Search bundled API reference documents.' That is clear and unambiguous, but it never differentiates this tool from close siblings such as bharosa_docs_search or bharosa_api_details, which an agent must distinguish before choosing.

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?

There is no statement of when to use this tool versus the five sibling search/detail tools. The description only clarifies what the tool does not do (execute methods); it offers no routing guidance for choosing between bharosa_api_search, bharosa_docs_search, or bharosa_api_details.

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