VPS_updateProjectV1

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

Describes preserving data volumes and applying changes from compose file. Without annotations, it lacks details on downtime, error handling, or effect on existing containers. Could be more transparent.

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?

Three sentences, focused and front-loaded with the main verb. No unnecessary words.

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 the action, use cases, and data preservation. No output schema, so return values not required. Minor gap: no mention of what happens after update (e.g., container restart).

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 covers both parameters with descriptions (projectName and virtualMachineId). Description does not add additional meaning to these parameters 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 it updates a Docker Compose project by pulling latest images and recreating containers. It distinguishes from related sibling tools like create, delete, restart, start, stop.

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 mentions use cases: deploy updates, apply config changes, refresh images. Does not include explicit when-not-to-use or alternatives, but the context is clear given sibling names.

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