apic_get_capacity_metrics

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

With no annotations, the description must convey behavioral traits. It states what data is returned (current usage, max capacity, utilization, context) but does not disclose whether data is real-time, cached, or any access permissions needed. For a read-only tool with no parameters, the disclosure is adequate but could be more detailed.

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 extremely concise: two sentences plus a bullet list. It front-loads the main action ('Retrieve fabric capacity metrics') and provides key details without 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?

Given no parameters and no output schema, the description explains the return structure adequately. It could mention the data freshness or scope, but for a simple retrieval tool it is complete enough for an agent to understand the tool's output.

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?

There are no parameters, so schema coverage is trivially 100%. The description adds value by listing the returned fields (current usage, maximum capacity, etc.), which goes beyond the empty schema. Baseline for 0 params is 4, and the description meets that.

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 fabric capacity metrics per node, listing specific fields. While the purpose is clear, it does not explicitly distinguish from sibling tools like apic_get_resource_utilization or apic_get_cpu_utilization, though the 'fabric capacity' context provides some differentiation.

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 mentions 'useful for capacity planning and resource monitoring,' providing general usage context. However, it does not specify when to avoid this tool or mention alternative tools (e.g., apic_get_cpu_utilization for CPU-specific metrics).

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