apex_add_leaderboard

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

With no annotations indicating read-only or destructive behavior, the description bears the full burden. It only states 'Add a ranked leaderboard table' without detailing side effects, required permissions, or what changes are made to the page. The SQL alias requirement is a technical constraint, not transparency about behavior.

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 very short (two sentences), which is concise. However, the second sentence is cryptic and not fully informative, sacrificing clarity 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?

Given 10 parameters and an output schema, the description is too sparse. It omits context such as how the leaderboard integrates with the page, what the output looks like, or any prerequisites (e.g., existing page_id). The schema partially fills this gap, but the description itself is incomplete.

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?

While schema coverage is 100%, the description's alias requirement ('RANK, NAME, VALUE') conflicts with the schema's label_column default 'LABEL' and the sql_query example using LABEL and VALUE. This creates confusion rather than adding meaningful parameter clarification.

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 'Add a ranked leaderboard table', specifying a distinct verb and resource. This differentiates it from sibling tools like apex_add_region or apex_add_metric_cards. However, the second sentence about SQL aliases introduces ambiguity and does not fully align with the schema.

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 a constraint ('SQL must alias RANK, NAME, VALUE') but gives no guidance on when to use this tool versus alternatives. There is no mention of appropriate scenarios, prerequisites, or when not to use it.

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