create_work_package

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

Discloses that it writes immediately and may notify users unless notify is false, and explains default typeId behavior. Annotations already indicate non-readonly, non-idempotent, non-destructive, so description adds useful context.

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 sentences, front-loaded with purpose, and includes key behavioral details without extraneous information. Every sentence 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?

Given 14 parameters and no output schema, the description covers only a few parameters and the return value (resource + URL). It lacks details on many optional parameters and their implications, making it somewhat incomplete for complex usage.

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 description coverage, the description adds meaning for typeId (omit to use default) and notify (controls notifications), but does not explain other parameters like startDate, dueDate, assigneeId, etc. Offers some value but incomplete.

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 'create' and resource 'work package', and specifies it returns the created resource plus browser URL. It distinguishes from sibling tools like update_work_package and delete_work_package.

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?

Provides explicit usage context: 'Use only for a new task in a resolved project' and mentions notification behavior. It does not explicitly list alternatives but implies it is for creation only.

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