update_epic

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

Minimal disclosure: indicates update but does not explain destructive behavior (overwrites or patches), optimistic locking via version, or authentication needs. With no annotations, description carries full burden but falls short.

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?

Single sentence with 10 words, no wasted text. Efficiently communicates the core purpose.

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?

Incomplete given complexity: 8 parameters, no output schema, no annotations. Missing details on version mechanism, default behavior for omitted fields, and return value. A mutation tool needs more context.

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?

Adds value by summarizing updateable fields (subject, description, status, assignee, color) beyond the schema, but omits 'tags' and 'version' (required). Schema coverage is 50%, and description partially compensates but has inconsistency (assignee vs assigned_to).

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 action 'Update' and resource 'existing epic', and lists the specific fields that can be updated, distinguishing it from create/delete/other update tools.

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 guidance on when to use this tool versus alternatives like create_epic or other update tools. The description does not mention prerequisites or context.

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