hyperspace_freeze_collection

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

With no annotations, the description carries the full burden: it discloses the core effect (read-only, blocks inserts) and the return shape ('ok/error status object'), which is helpful since no output schema exists. It does not address reversibility, required permissions, whether existing data or other write operations (updates/deletes) are affected, or error conditions.

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 compact sentences, front-loaded with the action and effect, then the return value. No waste, though the description is on the thin side for a mutation tool.

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?

For a simple one-parameter mutation with no annotations and no output schema, the description covers the effect and return shape but omits reversibility, permission requirements, and collection identifier semantics. Adequate but with clear 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?

The single 'collection' parameter has 0% schema description coverage, so the description must compensate by explaining the identifier format (name vs UUID), and it does not. The parameter is only implicitly referenced by the phrase 'a collection'.

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?

States a specific verb and resource ('Freeze a collection') plus the resulting effect ('make it read-only, preventing new inserts'). It does not explicitly differentiate from the sibling hyperspace_unfreeze_collection, relying on the reader to infer the inverse relationship from the verb.

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?

Usage is implied by the stated effect (make read-only), but there is no explicit when-to-use vs when-not guidance and no mention of the unfreeze sibling or how to reverse the operation. An agent must infer the recovery path.

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