add_request_work_note

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

Description discloses that the tool appends a new journal entry and never modifies existing work notes. No annotations are provided, so the description carries the full burden, which it satisfies adequately.

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?

Description is two concise sentences with no unnecessary words. It front-loads the action and provides behavioral detail efficiently.

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 append operation with 2 parameters and no output schema, the description covers the main purpose and behavior. It could mention return value (e.g., success indicator) but is still fairly complete.

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 coverage is 0%, meaning no parameter descriptions in the schema. The description only mentions 'sys_id' in passing and does not explain the format or purpose of either parameter beyond the obvious. The agent needs more detail to correctly fill the parameters.

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 verb 'Add a work note', resource 'service request', and specifies it is the parent Request record (sc_request). This distinguishes it from siblings like add_incident_work_note and add_requested_item_work_note.

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?

Description implies usage by specifying the target record type (service request) and the need for a sys_id. It does not explicitly state when not to use or provide alternatives, but the context makes differentiation clear.

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