opnsense_tailscale_settings_set

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

Discloses that it is a mutation operation ('Update') and that only provided fields are changed (partial update). Also notes the required reconfigure step. With no annotations, the description covers the essential behavioral traits, though it omits potential side effects like auth key reset or route changes.

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, no wasted words. Front-loaded with purpose, then key instruction. Extremely concise while transmitting all necessary information.

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?

For a settings update with no output schema, the description covers the core action and follow-up step. Lacks details on default values or error conditions, but the required reconfigure instruction is critical and present.

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% with detailed parameter descriptions. The description adds no additional parameter-specific semantics beyond the schema, only a general statement about partial updates. Baseline 3 is appropriate.

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 tool updates Tailscale plugin settings (verb+resource). It adds that only provided fields are changed, which clarifies scope and distinguishes from related tools like opnsense_tailscale_settings_get (get settings) and opnsense_tailscale_service_control (service actions).

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 instruction to run opnsense_tailscale_service_control with 'reconfigure' after updating, which is a critical usage step. However, lacks explicit guidance on when not to use it (e.g., vs. other methods) or prerequisites.

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