save_to_hypervault

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

With no annotations provided, the description carries the full burden. It discloses key behaviors: permanent saving, shareable URL creation, and automatic wrapping of React/JSX content into a standalone page. It does not mention immutability defaults or versioning, but those are covered in the parameter schema, so the description adds meaningful behavioral context.

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: the first states the core purpose and the second adds a key automation feature. It is front-loaded, concise, and 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?

Despite the tool's complexity (9 parameters, output schema), the description plus the rich parameter schema provide sufficient context for correct usage. The description covers the core action and a notable behavior (JSX wrapping), while the schema handles remaining details. It could be more explicit about mutable documents, but overall it is complete enough.

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 all parameters are already documented. The description adds minor context by mentioning that a bare React component can be passed and will be auto-wrapped, which relates to 'content' and 'type', but it does not extend meaning for other parameters beyond the 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?

The description uses the specific verb 'Save' and identifies the resource 'HyperVault' and the outcome 'get back a shareable URL'. It also lists example artifact types (HTML, React/JSX, report, game) and distinguishes itself from sibling tools by emphasizing permanent storage and automatic JSX wrapping.

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 implies usage for saving new artifacts and highlights automatic JSX detection, but it does not explicitly contrast with alternatives like write_artifact or state when not to use this tool. The guidance is inferred rather than explicit.

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