getSwitchStackDetail

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

No annotations are provided, so the description carries full burden. It only states 'fetch detailed information' without disclosing behavioral traits such as error handling, rate limits, authentication requirements, or effects of invalid stackId. Minimal transparency.

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 concise sentence, which is appropriately sized. However, it lacks structure such as bullet points or additional context, and it could be more informative without sacrificing conciseness.

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 the complexity (3 parameters, no output schema, many siblings, no annotations), the description is insufficient. It does not explain the return format, how to obtain a stackId, or how this tool differs from similar tools like getSwitchDetail or listSitesStacks.

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 67% (siteId and customHeaders have descriptions, stackId does not). The description adds no additional meaning beyond the schema. It does not explain the format or expected value of stackId, nor does it elaborate on siteId or customHeaders beyond what is in the schema.

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 it fetches detailed information for a specific switch stack. This distinguishes it from getSwitchDetail (individual switch) and other stack-related tools, but does not explicitly differentiate from siblings like listSitesStacks or getStackPorts.

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?

No guidance on when to use this tool versus alternatives. Siblings include many similar get* tools, but the description provides no context about selection criteria, prerequisites, or when to choose this over others.

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