mailu_update_relay

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

With no annotations, the description carries the full burden. It simply says 'updates a relay' without disclosing any side effects, permissions, or behavioral traits. It does not indicate whether the update is destructive or safe.

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 concise sentence, but it lacks structure. It is short enough but could be better organized into key information points.

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 tool with 3 parameters and no output schema, the description should at least indicate that 'name' identifies the relay and 'smtp'/'comment' are optional updates. It fails to explain update semantics (e.g., merge vs replace) or mention the required parameter.

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 33% (only 'name' described). The description mentions 'smtp' and 'comment' but adds only minimal context ('SMTP host'). It does not clarify formats, constraints, or optionality, leaving much burden on the parameter names alone.

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 'Updates a relay (SMTP host, comment)' which gives the verb 'update' and the resource 'relay', and hints at the parameters. It distinguishes the tool from create/delete/get relay siblings, though it is in French while the tool name is in English.

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 is provided on when to use this tool versus alternatives like mailu_create_relay or mailu_delete_relay. There is no discussion of prerequisites or scenarios.

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