apic_get_bridge_domains_multicast

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

No annotations provided, so description bears full burden. Describes return content in detail (GIPo addresses, IGMP snooping, etc.). Implicitly read-only ('Retrieve'), but does not mention potential size or performance implications. Adequate for a simple GET.

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?

Front-loaded with main purpose; uses bullet list for return details. No extraneous words. Concise and well-structured.

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?

Comprehensive for a no-parameter tool; explains return fields. Lacks prerequisites, permissions, or error handling, but these are less critical for a simple read. Output schema absent, but description covers it.

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?

Tool has 0 parameters. Per guidelines, baseline is 4. Description adds value by listing return content beyond empty 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?

Description clearly states it retrieves multicast information for all bridge domains. Specific verb 'Retrieve' and resource 'multicast information for all bridge domains'. Distinguishes from sibling apic_get_bridge_domain_multicast_by_tenant by scope.

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?

Implicitly indicates use for all bridge domains; sibling tool exists for specific tenant. No explicit when-not or alternatives, but context is clear enough for agent to infer.

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