manage_module_work_items

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

Annotations indicate readOnlyHint=false (modifies data) and openWorldHint=true. The description adds context that the operation is a single call and requires at least one ID array. It lacks details on idempotency or error behavior, but with annotations, this is adequate.

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 two sentences plus a bullet list, very concise. Every sentence adds unique value: the first states the main action, the second gives a constraint, and the list explains parameters. No wasted words.

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 tool has 4 parameters, no output schema, and moderate annotations. The description covers the core functionality and parameter requirements. It could mention what happens if a work item is already present, but overall it is complete enough for correct invocation.

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?

Despite 0% schema coverage, the description provides a full docstring-style explanation for each parameter (project_id, module_id, add_ids, remove_ids) with types and purposes, adding significant meaning beyond the input 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 it adds or removes work items on a module in a single call. It uses specific verbs ('add', 'remove') and resource ('work items on a module'), and distinguishes from sibling tools like list_module_work_items (list-only) and manage_module_archive (archive).

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 explicitly notes that at least one of add_ids or remove_ids must be provided, giving a clear usage constraint. However, it does not contrast with alternatives like other module tools or specify when to use add versus remove.

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