ruddur_create_heading_snapshot

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

Annotations already indicate this is a write operation (readOnlyHint=false). The description adds the auth scope requirement, which is useful context beyond annotations. However, it does not disclose other behavioral traits such as whether snapshots overwrite existing names, side effects, or return behavior.

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 a single sentence plus a scope note. Every word earns its place, with no redundancy or filler.

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?

The tool has no output schema, so the description should explain return values or expected outcome, but it does not. It also fails to clarify what a 'Heading snapshot' is, what data it captures, or what required parameters (beyond id) are needed. The schema is generic and not tailored to snapshots, leaving significant gaps for a user to infer.

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 the baseline is 3. The description does not add parameter-specific details; it only mentions 'named' but does not map that to a schema property. The generic body/query/pathParams descriptions carry the burden, and the description does not compensate for snapshot-specific semantics.

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 'Create a named Heading snapshot' with a specific verb and resource. It distinguishes from siblings like ruddur_create_heading (creates a heading, not a snapshot) and ruddur_restore_heading_snapshot (restores, not creates).

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 provides only a scope requirement ('Requires scope: content.manage') but gives no guidance on when to use this tool versus alternatives. It does not mention any exclusions or contexts where snapshot creation is appropriate.

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