Add or update a work package

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

With no annotations provided, the description carries the full burden and does disclose meaningful behavior: unknown dependency ids and cycles are rejected, and a benefit without an owner produces a warning. It does not, however, state whether updates are partial or full replacements or what happens when an id does not exist, which are significant traits for a mutation tool.

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?

The description is compact: one sentence for the action, one for the id branch, one for validation behavior. The bilingual duplication doubles the length but keeps each language self-contained, and there is no fluff. Slightly below 5 because the title 'Add or update a work package' already overlaps with the first sentence.

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?

For an 18-param mutation tool with no annotations and no output schema, the description covers the core upsert and error/warning semantics but leaves gaps: no return shape, no update-replacement semantics, and no guidance on updating a nonexistent id. It is minimally viable but not fully complete for such a complex tool.

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 89%, so the schema already documents most parameters and the baseline is 3. The description adds real meaning beyond the schema by explaining that id switches add/update mode and by exposing validation coupling between dependsOn, benefit, and benefitOwner. That justifies a 4.

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 names a specific verb and resource: 'Save a work package to the engagement', and immediately disambiguates the add/update branch: 'Pass an id to update, omit it to add.' This distinguishes it from sibling tools such as add_transition_state and prioritize_work_packages, which target different artifacts, so an agent can select it without opening the schema.

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 gives clear operation context: a work package is a gap-bundled execution unit saved to an engagement, and the id parameter selects update vs add. This is concrete invocation guidance. However, it does not name sibling alternatives or state when not to use it, so explicit exclusions and routing cues are missing.

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