put_routers_configs_assign

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

Adds behavioral details beyond annotations: configs are sent within 1-2 minutes, immediate if online, queued if offline, and no assignment on error. Annotations only indicate non-read-only and non-destructive.

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?

Description is moderately concise but includes unnecessary details like permission inline. Could be tightened without losing clarity.

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 no output schema, description adequately covers behavior for online/offline routers, latency, error handling, and permission requirements. Sufficient for a write 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?

Description adds meaning by stating config can be 'none' (removing assignment), which is not evident from schema. Schema descriptions are basic; description compensates with usage hints.

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?

Description clearly states it assigns a config to routers, with specific verb 'assign' and resource 'routers/configs'. It distinguishes from sibling tools like put_routers_configs_by_config_id (update config details) and put_routers_configs_default (set default config) by focusing on assignment to routers.

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 context: required permission, online/offline behavior, and latency. However, it does not explicitly state when to use this tool vs alternatives (e.g., put_routers_configs_by_config_id for updating config details) or when not to use it.

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