rotate_webhook_secret

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

No annotations are provided, so the description must disclose behavior. It states that the new secret is returned and shown only once, which is crucial for the agent to know (must save it). It implies a state change (rotation), but doesn't detail irreversible effects or old secret invalidation. However, the 'only once' warning adds significant transparency.

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 sentences, directly to the point, with the most critical info (new secret shown once, user confirmation required) front-loaded. No fluff or redundancy.

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 single-parameter tool with no output schema, it covers the essential points: what it does, what it returns, and when to call it. It could mention the 'id' parameter explicitly, but the simplicity and common naming make that minor. Overall, it's sufficient for an agent to invoke correctly.

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 0%, and the description doesn't explicitly explain the 'id' parameter. However, with only one parameter named 'id', it's self-explanatory that it's the webhook endpoint identifier, especially given the tool name. The description adds minimal value beyond the schema, but the low parameter count makes it adequate.

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 action ('Rotate'), the resource ('webhook endpoint's signing secret'), and the key outcome (returns the NEW secret shown only once). It distinguishes itself from sibling tools like update_webhook and list_webhooks by focusing on secret rotation specifically.

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 explicitly says 'Only call after the user confirms', providing a clear prerequisite for use. It doesn't explicitly mention alternatives, but the tool name and description make it clear it's for rotation, and siblings like update_webhook serve general updates. The user-confirmation context is valuable guidance.

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