apex_add_spotlight_metric

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

Annotations are all false, providing no safety/behavioral signal. The description adds little beyond the fact that it 'adds' a metric, failing to disclose that it likely executes the provided SQL query and modifies the page. No side effects, permissions, or dependencies are mentioned.

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 sentence with no filler. It is concise and to the point, though it sacrifices informative detail for brevity.

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?

With 13 parameters and 4 required, this is a complex tool. The description provides no context about how the metric appears on the page, what the SQL query should return, or how it integrates with regions. The minimal phrasing is inadequate for the tool's complexity.

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 100%, so the baseline is 3. The description loosely maps 'value', 'label', and 'optional trend' to params like sql_query, label, and subtitle_sql, but adds no meaning beyond what the schema already provides.

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 uses a clear verb ('Add') and specific resource ('large spotlight metric'), mentioning key components (value, label, optional trend). It distinguishes this from generic 'add' tools, but not from closely related sibling tools like apex_add_metric_cards or apex_add_gauge, so it falls short of a 5.

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 is given on when to use this tool versus alternatives such as apex_add_metric_cards, apex_add_gauge, or apex_add_stat_delta. There are no exclusions or context cues, leaving the agent to infer usage from the name alone.

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