credit_note_show

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

The description does not disclose any behavioral traits beyond 'Show details'. There are no annotations, so the description carries full burden, yet it lacks information about read-versus-write, error handling, authentication requirements, or whether the tool is safe to call (e.g., no side effects). The verb 'Show' implies a read-only but doesn't explicitly confirm non-destructive behavior.

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 optimally concise: a single sentence ('Show details of a specific credit note') with no wasted words. It front-loads the action and resource immediately.

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?

Given the tool 's simplicity (one required parameter, no output schema, no nested objects), the description covers the basic purpose. However, it lacks detail on what 'details' includes (e.g., which fields are returned) and whether any special conditions apply. For a minimal tool, it is adequate but not comprehensive.

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?

The schema already provides a clear description for the required parameter 'id' ('Credit note ID (UUID)'). The tool description adds no additional semantic meaning beyond what the schema offers. With 100% schema coverage, the baseline is 3.

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 'Show details of a specific credit note', with a specific verb ('Show') and resource ('credit note'), which distinguishes it from sibling tools like credit_note_list (which lists all credit notes).

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 usage guidelines are provided. The description does not mention when to use this tool over alternatives (e.g., credit_note_list) or any prerequisites. The need for a specific ID is implied by the required parameter, but no explicit context is given.

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