apex_add_heatmap_grid

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

Annotations are all false (readOnly=false, idempotent=false, etc.), so the description carries the full burden for behavioral disclosure. It only states 'Add' without mentioning side effects, idempotency, permissions, or what happens to existing regions or data. This is a mutation tool with no additional 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?

A single sentence that is front-loaded with the action and object, with zero redundant information. It is concise yet informative enough for a basic understanding.

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 tool's complexity (9 parameters, 3 required) and the existence of a rich schema with an example SQL, the description is adequate but incomplete. It doesn't mention prerequisites, whether it creates a new region, or how existing settings are affected. The schema fills many gaps, but the description itself omits important context.

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 89%, so parameters like sql_query, col_column, and value_column are already well-documented in the schema. The description adds minimal semantic context beyond the schema, only hinting that color intensity corresponds to values, which aligns with the existing parameter descriptions.

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 action ('Add'), the specific resource ('heatmap grid'), and the key behavior ('color intensity based on values'). This distinguishes it from sibling tools like apex_add_jet_chart or apex_add_gauge, which add other visualization types.

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 implies usage when a heatmap grid is desired, but it provides no explicit guidance on when to use this over alternatives or any exclusions. No sibling tools are mentioned, and no conditions or prerequisites are stated.

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