Update ticket conversation

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

Annotations already declare mutation (readOnlyHint=false), idempotency and non-destructiveness, so the description rightly focuses on the editability restriction, which is genuinely additive. It does not say whether body replaces existing content wholesale, nor what error/response results from attempting to edit a non-API note, which are the details an agent would still need.

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 short sentences, the action first and the restriction second; nothing is redundant or padded.

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?

With full schema coverage, annotations and an output schema, the structured data carries most of the load, and the description adds the one non-obvious eligibility rule. Still missing is any indication of replace-vs-merge semantics or failure behavior, which matters for an edit operation.

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 description coverage is 100%, and the schema already documents body as HTML content, attachments constraints (15 files / 40 MB, FRESHSERVICE_ATTACHMENT_DIRS) and conversation_id. The description adds nothing about parameters, so baseline 3 applies.

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?

States a specific verb ('Edit') and resource ('a note or reply'), which clearly separates it from the create-side siblings send_ticket_reply, create_ticket_note and delete_ticket_conversation. It does not name those siblings, so differentiation is implied rather than explicit.

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 eligibility constraint ('Only notes and replies created through the API/agents can be edited') gives a real precondition, but there is no guidance on when to edit versus delete-and-recreate, and no mention of what to do for older/human-authored notes other than that they cannot be edited.

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