Freeze a snapshot

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

With no annotations, the description covers key behavioral traits: freezing the current version, creating a unique URL, and reading credentials from .tempmd. However, it omits whether the operation is destructive, idempotent, or has authentication requirements beyond credential file.

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 two sentences, front-loaded with purpose, and includes relevant nuance. Every sentence adds value without redundancy.

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?

Given the tool has 4 parameters, no output schema, and no annotations, the description covers high-level purpose but lacks parameter explanations, error handling, return details, and prerequisites, leaving significant gaps.

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 50%, covering only label and project_dir. The description adds no parameter-specific information; the mention of .tempmd relates to credential handling but not directly to parameter semantics. The missing temp_id and update_token remain undescribed.

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 tool freezes the current Temp version, creates a fixed URL, and is intended for sign-offs and exactness. It distinguishes from siblings like publish_temp and update_temp.

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 specifies when to use the snapshot (for sign-offs, where exactness matters) and contrasts with the canonical link serving the latest version. It also notes credential handling but lacks explicit not-to-use scenarios.

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