add_note

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

With no annotations, the description only clarifies the private parameter meaning. It does not disclose side effects, permission requirements, immediacy of action, or constraints beyond what the schema shows.

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?

Very concise at two sentences, no wasted words. First sentence front-loads purpose. Slightly more length could include parameter clarifications without harming conciseness.

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?

Minimal completeness given the tool's context. Lacks explanation of return value, potential errors, or when to use. For a 3-param tool with no schema descriptions, more context is needed for effective use.

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 has 0% description coverage. The description adds meaning only for the 'private' parameter, leaving 'body' and 'ticket_id' unexplained. Body likely contains note text, but no clarification.

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?

Description clearly states 'Add a note to a ticket', which is a specific verb+resource. It distinguishes from sibling tools like reply_ticket by mentioning the private flag meaning internal note, implying use case.

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 explicit guidance on when to use this tool versus alternatives. Only mentions the private parameter meaning, but does not provide context for choosing between add_note and reply_ticket or other tools.

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