Update service

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

Annotations already cover safety (readOnly=false, destructive=false, idempotent=true). The description adds valuable context by explaining that unknown fields can be passed via 'extra', which aligns with and operationalizes the openWorldHint annotation. No contradiction.

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 compact sentences, front-loaded with the main action. The second sentence efficiently explains the extensibility mechanism. No filler or redundant information.

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 update-by-UUID tool with four annotations and a schema, the description is largely sufficient: it identifies the resource, the required UUID, and how to handle additional fields. It does not mention return value, but no output schema exists and the tool's purpose is straightforward.

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 schema description coverage at only 20%, the description must compensate. It explains that 'extra' accepts 'any other Coolify service field', giving concrete examples. However, it does not elaborate on the meaning/format of 'name', 'description', 'instant_deploy', or how they interact, leaving the other four parameters under-specified.

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 'Update a service by UUID' — a specific verb ('Update') and resource ('service'), distinguishing it from sibling update tools for applications, databases, servers, etc. It also clarifies the parent domain by referencing 'Coolify service field'.

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: use exposed common fields for typical updates and the 'extra' object for any other Coolify service fields. However, it does not explicitly contrast with alternatives (e.g., createService, controlService) or state when NOT to use this tool.

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