pbs_node_subscription_set

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

Discloses mutation behavior (PUT endpoint), default dry-run, execution effect (returns status/result), reversibility, and config dependency, all beyond what annotations would provide (none present).

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?

Three well-structured sentences, no redundant information, front-loaded with key action and mode (mutation, dry-run).

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 purpose, behavior, parameters, config, reversibility, and execution result; sufficient for correct agent usage given the presence of output schema and schema descriptions.

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 covers all 4 parameters fully. The description adds behavioral context (e.g., dry-run vs execute via confirm) that enriches the schema's technical details.

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?

Clearly states the action 'install and validate a subscription key on a PBS node' with a specific verb and resource. Distinguishes from siblings like pbs_node_subscription_check and pbs_node_subscription_get by focusing on the set 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?

Explicitly explains dry-run by default and confirm=True execution, mentions reversibility via pbs_node_subscription_delete, and notes the required PROXIMO_PBS_* config, giving clear when-to-use and when-not-to-use guidance.

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