publish_notes

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

No annotations provided; description compensates by disclosing side effects (updates local git notes ref, requires separate push). Clearly communicates write behavior and manual remote sync 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?

Two sentences plus side effect warning; every sentence is necessary. Front-loaded with purpose, no fluff.

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?

Output schema exists and params are fully documented. Description covers purpose and side effects. Could elaborate on the relationship to signed envelopes, but sufficient for a focused tool.

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 100%, so baseline is 3. Description adds minimal extra meaning beyond schema; param details are already in 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?

Description clearly states 'Publish local signed envelopes to git notes for CI Scroll Gate verification', providing a specific verb and resource. It distinguishes from sibling tools like create_envelope or list_envelopes by focusing on CI verification publishing.

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?

Gives explicit side effects and post-action requirement to push to remote. Implies usage for CI Scroll Gate verification, but lacks explicit when-not-to-use or alternatives.

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