Reload node network

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

Annotations already indicate readOnlyHint=false (write operation) and destructiveHint=false. The description adds value by specifying the exact mechanism ('reloads /etc/network/interfaces') and warning about potential SSH disconnection, which is a critical behavioral trait not captured in annotations.

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 sentences: one precise statement of action and one brief warning. No redundant words. Front-loaded with the core purpose.

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 tool's simplicity (single parameter, no output schema), the description covers the essential behavior and a key side effect. However, it lacks explanation of the parameter and does not mention expected outcomes or error conditions, making it merely adequate.

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 0% schema description coverage, the description should explain the 'node' parameter but does not. It only mentions 'pending network changes' without linking to the required node identifier. This omission forces the AI agent to infer parameter meaning from context.

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 specific action: 'Apply pending network changes (reloads /etc/network/interfaces)'. This distinguishes it from related tools like update_node_network (which modifies config) and list_node_network (which reads). The warning about SSH disconnection further clarifies the tool's impact.

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 explicit guidance on when to use this tool versus alternatives is provided. The description does not mention prerequisites such as having pending network changes via update_node_network, nor does it indicate when not to use it (e.g., during active sessions). The warning about SSH disconnection only implies caution, not usage context.

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