Update service

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

Annotations provide some behavioral hints (readOnlyHint=false, destructiveHint=false), but description adds only the HTTP method. No mention of idempotency, side effects (e.g., triggering deployments), permissions, or rate limits.

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 very short (three sentences) and concise, but it omits important information. It earns its place but could be expanded to cover key aspects.

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?

Given the complex input schema with many nested properties and low coverage, the description is inadequate. It does not explain that this is a partial update, what fields are updatable, or the effect on the service (e.g., triggering a deploy). No output schema defined.

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 coverage is only 11%, meaning most parameters lack descriptions. The description does not mention any parameters, so it adds no value 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 updates a service and specifies the API call (PATCH /services/{serviceId}). It distinguishes from create and delete tools, but doesn't differentiate from other update tools for different resources.

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?

No guidance on when to use this tool versus alternatives like create_service or other update tools. Implied usage for updating an existing service, but no explicit when-not or context.

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