plugin_upgrade

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

Adds important behavioral context beyond annotations: 'Existing settings and volumes created by the plugin persist across the upgrade'. Annotations (readOnlyHint=false, destructiveHint=false) are consistent and minimal, so description carries the burden well.

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 well-structured paragraphs with no unnecessary words. First sentence states purpose, followed by prerequisites and parameter details. Every sentence adds value.

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 prerequisites, behavioral effects, parameter semantics, and return value. Output schema exists but description still notes return type. Fully complete for a plugin upgrade tool.

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?

Despite 0% schema description coverage, the description fully compensates by defining both parameters: 'name - The plugin name to upgrade' and 'remote - Reference to upgrade to, e.g. 'vieux/sshfs:next' (default: same as name)' with a practical example.

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 verb 'Upgrade' and the resource 'an installed plugin to a newer version'. It distinguishes itself from sibling tools like plugin_install and plugin_disable.

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 states prerequisites: 'The plugin must be disabled first — call plugin_disable before this, then plugin_enable afterwards'. Explains the remote parameter and when to omit it.

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