get_request_work_notes

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

Discloses ordering (newest first), pagination (limit/offset), filtering (exact match on created_by), and return fields. No annotations to contradict; however, missing details on authentication or error handling.

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?

Two concise sentences with front-loaded action. No redundant information; each part adds value.

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?

Covers parameters and return fields effectively. Could mention error behavior or permissions, but sufficient for a read tool with pagination given output schema exists.

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?

With 0% schema coverage, description fully compensates: explains sys_id as identifier, limit/offset as pagination with defaults, and created_by as exact match filter with example. Adds meaning beyond raw schema.

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 'Read' and resource 'work notes on a service request' with specific record type 'sc_request'. Differentiates from sibling tool 'get_incident_work_notes' by specifying the parent record type.

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?

Implies usage through naming the record type, but does not explicitly state when to use versus alternatives like 'get_incident_work_notes'. No 'when not to use' guidance.

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