apex_add_comparison_panel

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

The description only states 'Add', which aligns with readOnlyHint=false, but does not disclose any additional behavioral traits such as side effects, required permissions, or where the panel is inserted. With annotations covering the basic read/write nature, the description adds no extra behavioral context beyond what is already known.

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 sentence that is direct and front-loaded, efficiently conveying the tool's purpose without any filler. Every word contributes to understanding the tool's function.

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 that the schema thoroughly documents all parameters and an output schema exists, the description is sufficient to understand what the tool does. The absence of usage guidelines slightly reduces completeness, but the tool's simple add operation and rich schema compensate, making it adequately complete for invoking correctly.

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 schema provides complete descriptions for all 10 parameters (100% coverage), including format examples for metrics. The description adds no parameter-specific information beyond the general 'two columns of metrics' phrase, which is already reflected in the schema. This matches the baseline for high schema coverage.

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 adds a side-by-side comparison panel with two columns of metrics, which is a specific verb and resource. It distinguishes from sibling tools like apex_add_metric_cards or apex_add_ribbon_stats by explicitly describing the two-column layout, making its purpose unambiguous.

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 provides no guidance on when to use this tool versus alternatives, such as apex_add_metric_cards or other visualization tools. There are no prerequisites, exclusions, or alternative tool mentions, leaving the agent without context for selection.

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