Read Bharosa API Documentation

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

Annotations already declare readOnly/idempotent/non-destructive, so safety is covered. The description adds genuinely new context: what the response contains, that it resolves referenced definitions via schema document IDs, and that no execution or credentials are involved.

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 compact sentences, front-loaded with the primary action, then the chaining hint, then the boundary statement. No filler.

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?

Output schema exists so return values need not be spelled out, and the description still sketches them; chaining guidance and the no-execution boundary round it out. The missing piece is how to source the operationId.

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?

Only one parameter with 0% schema description coverage; the schema constrains its format (pattern, max length) but not its meaning. The description implies operationId identifies the operation but never says how to obtain one (presumably from bharosa_api_search), leaving the main practical gap.

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?

States a specific verb ('Read') and resource ('one canonical API operation') and enumerates the payload: method, path, parameters, body/responses, examples. It implicitly distinguishes itself from the search/list siblings by returning full detail for a single operation, though it never names them.

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?

'No API execution or credentials' scopes it as documentation-only, and 'Follow schema document IDs for referenced definitions' hints at chaining to a docs-read tool. But there is no explicit when-to-use-this-vs-bharosa_api_search or where to obtain an operationId.

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