bulk_publish_draft_notes

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

The description covers the main action and optional behaviors but does not disclose additional traits such as irreversibility, permissions, or side effects. The 'openWorldHint' annotation warns of unknown side effects, but the description adds little beyond the schema.

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 concise sentences efficiently convey the core functionality and optional features. No redundant information; structure is front-loaded.

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 description covers the main purpose and optional parameters but lacks information about return values or what happens after publishing. Given no output schema, this is a gap. Version constraints are mentioned, which is helpful.

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?

All parameters are fully described in the schema (100% coverage). The description adds valuable context that 'reviewer_state' can be set even with no drafts, improving understanding beyond schema alone.

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 primary action: 'Publish all draft notes for a merge request.' It distinguishes from the sibling 'publish_draft_note' by specifying bulk operation. Additional optional behaviors are mentioned.

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 implies the tool is for bulk publishing but does not explicitly differentiate from singular 'publish_draft_note' or provide when-not-to-use guidance. The optional features are listed but no context on when to use them.

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