add_commit_separator

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only says 'Add', implying mutation, but doesn't state whether the separator is appended, inserted, or overwritten, or what happens if the branch note is missing. No side effects or return behavior are mentioned.

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 sentence, front-loaded with the verb and object, with no redundant words. It is highly concise and structured effectively for quick parsing.

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?

With 4 required parameters and no output schema or annotations, the description is insufficiently complete. It lacks context about when this operation is necessary, how it interacts with existing branch note content, and what the expected result is. The tool's specific role within the branch note workflow is not explained.

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% with each parameter described, so the description adds little beyond grouping them as 'commit metadata'. It doesn't explain relationships between parameters (e.g., why projectName is needed alongside commitHash) or any special formatting. Baseline of 3 is appropriate.

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 ('Add') and the resource ('commit separator to the branch note'), which distinguishes it from sibling tools like clear_branch_note or update_branch_note. However, it doesn't elaborate on what a 'commit separator' is, leaving some ambiguity for an agent unfamiliar with the domain.

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 guidance on when to use this tool versus alternatives. It does not mention prerequisites (e.g., whether a branch note must already exist), nor does it reference sibling tools like update_branch_note or clear_branch_note for comparison.

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