update_webhook

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

Discloses that omitted parameters are unchanged and topic is immutable. Without annotations, covers key constraints but could mention immediate effect or potential disruption.

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 what can be modified, followed by use cases. No 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?

Covers purpose, constraints, and usage scenarios. Lacks return value info but acceptable for an update tool with no output schema.

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?

With only 20% schema coverage, description adds meaning for each modifiable field and explains the constraint on topic. Does not fully describe each parameter but compensates well.

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?

Description clearly states the tool modifies specific fields of a webhook subscription (callbackUrl, format, includeFields, metafieldNamespaces) and explicitly notes that topic cannot be changed, distinguishing it from create_webhook and delete_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?

Explicitly lists when to use (migrating endpoint, switching format, tightening payload) and when not to (to change topic, delete and recreate). Provides clear alternatives.

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