topos_begin_refactor

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

Discloses side effect (writes snapshot record) and return value (snapshot_id). Annotations confirm idempotency and non-destructiveness, with description adding complementary detail. No contradictions.

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?

Extremely concise: two sentences with no wasted words. Front-loaded with core action, then follow-up steps. Every sentence earns its place.

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?

Completely describes the tool's purpose, side effects, return value, and next steps. No output schema needed as return value is specified in text. Fits well within the refactor workflow.

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?

Input schema has 100% coverage with descriptions for all parameters. Description does not add extra meaning beyond the schema, meeting baseline expectations but not exceeding.

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?

Clearly states the tool persists a baseline snapshot, uses specific verb+resource (persist snapshot), and distinguishes from siblings by referencing topos_assess_snapshot. Also specifies when to use (baseline not git revision).

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?

Explicitly says when to use it (baseline not committed git revision) and what to do after (edit file, call topos_assess_snapshot). Provides clear workflow context without ambiguity.

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