pmg_mynetworks_add

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

No annotations provided, so description carries full burden. It fully discloses mutation type, dry-run behavior, config requirement, trust implications, and return values (plan vs execution result).

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?

Four sentences, each informative and necessary. No redundant information. Front-loaded with mutation type and action.

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 output schema exists, description still adds value by explaining plan vs execution result. Covers config, trust implications, and dry-run behavior. Comprehensive for a 4-param 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?

Schema coverage is 100%, baseline 3. Description adds meaning beyond schema by explaining dry-run behavior for confirm, config requirement, and return structure. However, not all parameters (comment, proximo_target) are explicitly discussed.

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 action (add), resource (PMG mynetworks trusted relay list), and type (mutation). It distinguishes from the sibling pmg_mynetworks_remove by explicitly naming it as the reverse operation.

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?

Provides explicit guidance: dry-run by default, confirm=True to execute, needs PROXIMO_PMG_* config, warns to only add CIDRs you control. Also mentions the reverse operation, giving clear context for use.

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