swm_get

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

With no annotations, the description carries the burden of behavior, and explicitly saying 'read-only' is a useful and material disclosure: it signals no mutation of switch state. It does not go further to describe what data is returned or any error conditions, but the core behavioral trait is 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?

The description is a single front-loaded phrase, 'Switch management data (read-only)', with no redundant words or filler. Every token contributes semantic value, making it minimal while self-contained enough for its purpose.

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 tool with no parameters and no output schema, the description is very minimal and does not clarify what the returned switch management data contains, its format, or how it differs from similar-looking siblings like swm_show, swm_detail, or swm_search. This leaves the agent guessing about expected output and proper selection.

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?

The tool has zero parameters and schema coverage is complete, so there is nothing for the description to add about parameter meaning. The baseline for a no-parameter tool is 4, which is appropriate here.

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 identifies the resource as 'Switch management data' and labels it 'read-only', but it lacks an explicit verb and does not differentiate from likely same-purpose siblings such as swm_show or swm_detail. It is not a tautology, but it stops short of clearly stating that this tool retrieves or gets the data.

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 'read-only' qualifier implies the tool is appropriate when the user wants switch management data without modifying it. However, it gives no explicit when-to-use / when-not-to-use guidance and does not name any alternative sibling, so the guidance is only implied.

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