pmg_mynetworks_add

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

Discloses mutation status, dry-run safety, and execution path. With no annotations, adds value but misses details like persistence, immediate effect, or rollback implications.

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?

Compact and well-structured with labels like MUTATION, dry-run note, and example. Every sentence adds value without redundancy.

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 essential aspects: action, safety, requirements, and example. Lacks details on return values, error handling, or concurrency, but output schema may partially compensate.

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 low (25%). Description adds meaning for 'cidr' with example and explains 'confirm'. 'comment' and 'proximo_target' are not elaborated beyond schema, limiting parameter clarity.

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?

Explicitly states the verb 'add' and resource 'CIDR to PMG mynetworks trusted relay list'. The name and sibling 'pmg_mynetworks_remove' clearly distinguish it as the addition counterpart.

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 clear guidance: dry-run by default, confirm to execute, configuration requirement (PROXIMO_PMG_*). Implicitly advises to only add controlled CIDRs. Lacks explicit contrasts with alternatives, but context is sufficient.

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