replace-webhook

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

Discloses the destructive nature of the operation (complete replace with reset of omitted attributes). No annotations exist, so the description effectively carries the burden of behavioral disclosure.

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, front-loaded with purpose, followed by a crucial usage warning. No extraneous content.

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 replacement endpoint with a nested object schema and no output schema, the description covers the essential aspects: what it does, the complete replace behavior, and the nuance about resetting omitted fields. Lacks error handling or prerequisites but is sufficient.

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?

The description adds context that webhookId identifies the webhook and that requestBody must contain all attributes, reinforcing the schema. With 50% schema coverage, it partially compensates but does not elaborate on individual parameter details 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 clearly states it replaces the whole value of a webhook by ID, distinguishing it from partial updates like update-webhook or creation create-webhook.

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?

Provides explicit warning about the complete replace behavior and the need to include unchanged attributes, which guides usage. However, it does not explicitly compare with update-webhook for selective changes.

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