getSitesGatewaysGeneralConfig

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is carried by structured data. The description adds nothing further: it does not say what configuration fields are returned, whether the call is cached, or whether it requires the gateway to be online.

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?

It is a single sentence with no wasted words, but the brevity comes from omission rather than efficiency. There is no front-loaded scope statement or qualifier to anchor the agent.

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?

With only two parameters, full schema coverage, annotations, and no output schema, the structured fields carry most of the load — but the description still leaves the tool's scope ambiguous against several sibling getGateway* and *GeneralConfig tools. A single clause describing what 'general config' contains would close the gap.

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 description coverage is 100%, and the parameter descriptions already explain the siteId default via OMADA_SITE_ID and point to listSites/listDevices for discovery. The description adds no meaning beyond that, so the baseline 3 applies.

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 essentially restates the tool name: 'Get gateway general config' adds no information beyond getSitesGatewaysGeneralConfig. It does not distinguish this from close siblings such as getGatewayDetail, getSwitchGeneralConfig, or getApGeneralConfig, so an agent cannot tell which 'general config' surface it returns.

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?

There is no when-to-use guidance at all — no condition that selects this over getGatewayDetail, getGatewayWanStatus, or getGatewayLanStatus. The agent must infer scope purely from the name and the gatewayMac/siteId parameters.

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