Capture RE snapshot

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

Annotations already indicate readOnlyHint=true and idempotentHint=false. The addition of 'in-memory' and 'versioned' clarifies that the snapshot is not persisted and that each call creates a new version, which is helpful context. However, it does not explain side effects beyond that.

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?

A single sentence that is specific and free of fluff. It 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?

With 6 parameters, no output schema, and no connection to the larger snapshot workflow (e.g., diff_re_snapshots, list_re_snapshots), the description leaves many unknowns such as how to specify instances, what maxScripts limits, and what the tool returns.

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 only 17% (clientId has a description). The description maps some content to likely parameters (script hashes→includeScripts, remote schemas→includeRemoteSchemas, instance properties→instances) but does not explain label, maxScripts, or the exact format of instances. It should compensate for the low schema coverage but only partially does.

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 verb 'Capture' and the resource 'in-memory versioned snapshot' with specific contents (script hashes, remote schemas, instance properties). This distinguishes it from sibling tools like diff_re_snapshots and list_re_snapshots.

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?

No guidance is provided on when to use this tool versus alternatives like smart_snapshot or infer_remote_schemas. The description only says what it does, not when or why to use it.

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