books_get_credit_note_comments

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states 'Get comments for a credit note', which conveys the basic read operation but does not disclose details such as whether comments are returned in any specific order, if pagination is used, or if any permissions are required. It offers minimal insight beyond the tool's name and implied action.

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 a single concise sentence: 'Get comments for a credit note'. It is front-loaded with the action and target, contains no redundant words, and is appropriately sized for a tool with a single parameter and straightforward purpose.

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 tool with one parameter and no output schema, the description is minimally adequate. It states the primary function, and the schema covers the input. However, it does not specify what the response contains (e.g., array of comments, fields included), pagination, or error conditions, which might be expected given there is no output schema to fill the gap.

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 has 0% description coverage and one required parameter, creditnote_id. The description mentions 'credit note' but does not explicitly explain that creditnote_id is the identifier needed to fetch comments. While the parameter name is self-explanatory, the description adds no meaningful semantic detail to compensate for the lack of coverage.

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 uses the specific verb 'Get' and identifies the resource as 'comments for a credit note', which clearly distinguishes it from sibling tools like books_add_credit_note_comment or books_get_credit_note. However, it does not explicitly mention that the credit note is identified by an ID, though this is implied by the parameter.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention that creditnote_id is required, nor does it differentiate when to use this instead of books_get_credit_note (which might include comments) or other get tools. There are no explicit exclusions or context clues.

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