aiworkhub_manager_needfix_markdown_commit

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

No annotations are provided, so the description carries the full behavioral burden. "MANAGER WRITE" hints at mutation, but the description does not disclose side effects (does it create needfix items? is it idempotent? what happens on a stale preview_id?), and it is silent on permissions or reversibility for a write operation.

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?

A single short sentence with the mutation classification front-loaded via the MANAGER WRITE prefix. It is efficient and non-redundant, though its brevity comes at the cost of the missing detail noted elsewhere.

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?

An output schema exists so return values need not be described, but for an unannotated mutation tool with three undocumented parameters and an unclear relationship to its preview sibling, the description leaves too much for the agent to infer before calling it safely.

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 0% across 3 parameters. The word "preview" weakly hints that preview_id references a prior preview, but follow_links and source_paths are entirely unexplained, and "captured items only" does not map to any parameter. The description fails to compensate for the coverage gap.

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 verb ("commit") and a resource ("an exact Markdown preview"), and the MANAGER WRITE prefix signals mutation. However, "as captured items only" is cryptic and does not clarify what actually gets created, and the tool is not distinguished from its obvious sibling aiworkhub_manager_needfix_markdown_preview.

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?

There is no statement of when to use this versus the markdown_preview sibling, no prerequisite that a preview_id must first be produced by the preview tool, and no guidance on the follow_links/source_paths options. The agent must infer the workflow entirely.

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