itsm_register_webhook

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

With no annotations, the description carries the burden of behavioral disclosure. It mentions the webhook receives ticket state changes and lists event types, but does not clarify whether registration overwrites existing webhooks, verifies the URL, or any side effects. The lack of detail on lifecycle or error behavior leaves gaps.

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, front-loaded sentence with no redundant wording. It efficiently conveys the action, target, and event types.

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 simple one-parameter tool without output schema or annotations, the description covers the core purpose but omits operational details like whether registration is idempotent, how to manage multiple webhooks, or what a successful registration returns. This makes it adequate but not fully complete for an agent.

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 schema fully describes the only parameter (url) as "Webhook URL to POST events to", giving 100% coverage. The description adds value by specifying the exact event types (OPENED, UPDATED, RESOLVED) and connecting the URL to the purpose, enriching the meaning of the parameter 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 the tool registers a webhook URL to receive real-time ITSM ticket state changes, listing specific event types (OPENED, UPDATED, RESOLVED). It uses a specific verb (register) and resource (webhook URL), and stands out from sibling ITSM tools like itsm_create_ticket or itsm_get_ticket.

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 implies usage when real-time notifications are needed but does not explicitly contrast with alternatives like polling via list/get ticket tools. No when-not-to-use instructions or alternative tool names are provided.

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