manage_module_work_items

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

With no annotations, the description carries the burden of disclosing behavior. It states the primary effect (add/remove) and the precondition, but omits details like idempotency, failure modes, permission requirements, or what happens if the module/work item does not exist. This is basic mutation disclosure but lacks deeper side-effect 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?

The description is well-structured: purpose is front-loaded in a single sentence, followed by a necessary constraint, then an explicit parameter list. Every sentence adds value, and the format makes it easy to scan.

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 a mutation tool with 4 parameters and no output schema or annotations, the description covers the input semantics and a key rule. It does not describe the return value or error conditions, but given the simplicity of the operation, the description is largely complete for a competent agent.

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?

The schema coverage is 0%, but the description compensates fully with an Args list that gives semantic meaning to each parameter (e.g., 'UUID of the project', 'UUIDs of work items to add to the module'). It also adds a critical constraint about the relationship between add_ids and remove_ids, which is beyond schema.

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 a specific verb (add/remove) and resource (work items on a module), and explicitly notes the 'single call' capability. This distinguishes it from sibling tools like list_module_work_items (read-only) and manage_cycle_work_items (different resource).

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 provides clear context for when to use the tool (adding/removing work items on a module) and embeds an important usage constraint ('At least one of add_ids or remove_ids must be provided'). However, it does not explicitly mention alternatives or when not to use it, such as comparing with list_module_work_items for reading.

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