Delete a service

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

Annotations already mark the tool as destructive and non-idempotent; the description adds that it may notify recipients or change tenant data and that operator write opt-in is required, which are not present in the structured hints. It does not fully describe irreversibility, but destructiveHint covers that core aspect.

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 compact: two sentences plus endpoint and reference link. Every clause adds useful information—purpose, endpoint, body requirement, prerequisites, and side effects—with no filler 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 destructive delete tool with no output schema, the description covers the essential context: endpoint, body constraints, prerequisites, and potential side effects. It omits response details and error scenarios, but those are less critical given the annotations and simple parameter structure.

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 already provides rich descriptions for query and confirm, covering 67% of parameters. The description adds 'Body fields: none' and the URL path clarifies serviceId, but it does not explain the meaning of serviceId or add detail beyond what the schema already has. Adequate but not exceptional.

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 states the operation directly ('Delete a service') and gives the exact REST endpoint (DELETE /api/xm/1/services/{serviceId}), which clearly differentiates it from sibling tools like xmatters_get_a_service, xmatters_create_a_service, and xmatters_modify_a_service. An agent can immediately identify what this tool does.

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 mentions prerequisites ('Requires operator write opt-in and confirm:true') but gives no guidance on when to choose this tool over alternatives such as xmatters_modify_a_service or when deletion is appropriate. It does not contrast with sibling operations, so the agent must infer usage purely from the name.

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