getSwitchGeneralConfig

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

No annotations are provided, so the description carries full burden. The verb 'Get' implies a read-only operation, but no explicit statement about non-modification, auth requirements, or rate limits is included.

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?

The description is two concise sentences: first states purpose with included items, second provides a parameter hint. No unnecessary words.

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?

No output schema exists, and description does not explain return format or structure. While it lists some included configuration items, it lacks completeness for a get tool that returns complex data.

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 provides full descriptions for all 3 parameters (siteId, switchMac, customHeaders) with 100% coverage. The description adds value beyond schema by suggesting use of listDevices for switchMac, improving semantics.

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 retrieves general configuration for a switch and lists included parameters. However, it does not explicitly differentiate from similar sibling tools like getSwitchDetail or getSitesSwitchesGeneralConfig.

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?

The description provides a hint to use listDevices to obtain switchMac values, but offers no guidance on when to use this tool versus alternatives like getSwitchDetail or getSitesSwitchesGeneralConfig.

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