clickup_comment_update

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

With no annotations, the description covers key behaviors: full body replacement (no partial edits), resolution effect (strikes through, closes thread), and text rendering nuances (@mentions rendered, markdown not). However, it omits side effects like notifications for assignee changes, rate limits, or permission requirements.

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?

Three sentences with no redundancy. The first sentence states the purpose, the second adds a critical behavioral note (full replacement), and the third explains a key parameter effect and return value. Efficient and well-structured.

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?

The description adequately covers the tool's function and important behaviors for a 4-parameter mutation tool without output schema. It mentions return of updated object but lacks detail on the structure. Given the lack of annotations and output schema, slightly more context on permissions or error states would enhance completeness.

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 100%, so baseline is 3. The description adds value beyond schema by explaining that text is a full replacement and that resolved=true closes the thread. Parameter descriptions are detailed (e.g., assignee notification, text rendering), making semantics clear.

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 clearly states the verb 'Edit' and the resources 'text, assignee, or resolution state of a ClickUp comment on a task, list, or view'. It distinguishes from creation and deletion siblings by focusing on modification and includes critical details like full text replacement and resolution behavior.

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 implies use for editing an existing comment but does not explicitly state when to use this tool versus alternatives like clickup_comment_delete or clickup_comment_create. No when-not-to-use guidance is provided, leaving the agent to infer from the name and context.

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