scf_rotate_webhook_secret

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

Discloses two critical behaviors beyond what annotations convey: the old secret is invalidated immediately, and the new plaintext secret is returned exactly once. These are material consequences an agent must know before invoking the tool.

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?

Three short sentences front-load the verb and resource, then state the side effect and return behavior. There is no filler or redundant restatement of the schema.

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 two-parameter mutation with no output schema, the description captures purpose, admin requirement, immediate invalidation side effect, and the once-only plaintext return contract. Nothing operationally essential is missing.

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 coverage is 100% and both parameters already have descriptions showing where to obtain values. The description adds no parameter-level detail, so the baseline of 3 applies.

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 ('Rotate'), resource ('HMAC signing secret for a webhook endpoint'), and access level ('admin role'). It is clearly distinguishable from sibling webhook tools because rotation is uniquely named and described.

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 designation '(write — admin role)' gives clear context about authorization and operation type. It does not explicitly name alternatives or when-not conditions, but among siblings no other tool performs rotation, so the intended use is evident.

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