workflow_issue_log_append

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

No annotations are provided, so the description must carry the full behavioral disclosure. It only states the action and a negative constraint, but lacks details on side effects, error conditions, permissions, or output behavior. With 12 parameters, more context is needed.

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 very brief (two sentences) and front-loads the purpose. No extraneous content. However, given the tool's complexity (12 parameters), it could potentially include more useful information without being wasteful.

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?

Despite the existence of an output schema, the description does not mention return values or behavior details. With 12 parameters, no annotations, and only two sentences of description, the tool is not fully specified for an agent to use reliably.

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 coverage is 100%, so the schema already describes all parameters. The tool description adds no additional parameter information beyond the schema. Some parameters have helpful notes in the schema itself, but the description does not contribute to their semantics.

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 action ('append') and the resource ('local issue log markdown'), and distinguishes from siblings by explicitly noting it does not create MR or commit. This is specific and unambiguous.

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 says 'Use when only local issue log markdown should be appended,' which indicates the primary use case. It also says what the tool does not do (create MR or commit), implying alternative tools. However, it does not explicitly mention sibling tools or 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.