Skip to main content
Glama

Battery capture-rate rankings

get_rankings
Read-onlyIdempotent

League table of merchant NEM batteries over a date range, ranked by capture rate by default (actual revenue as a share of the forecast-informed benchmark; capture_perfect_pct is the share of the perfect-foresight ceiling). Each row has rank, duid, station, region, capacity, duration_band, capture_fc_pct, capture_perfect_pct, rev_per_mw_day, rev_per_mwh_day, total_rev, cycles_per_day and movement against the previous period of equal length. total_rev is MLF-adjusted over LP-solved days (through lp_through), so it differs from get_battery_revenue's gross every-day total. Units still commissioning and CONTRACTED or TOLLED units are listed under excluded, not ranked, unless include_arrangement is true (their spot revenue is not their commercial return). Check unit_class and peer_comparable before reading a gap as performance. It scans the whole fleet twice, so keep the range to a month or less; it can be slow or time out on long ranges. For one unit's revenue use get_battery_revenue.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "date_from": "<date_from>",
      "date_to": "<date_to>"
    },
    "name": "get_rankings"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoReturn only the top N ranked rows (default all); total_ranked gives the full count.
regionNoNEM region code: NSW1, QLD1, SA1 (South Australia), TAS1 or VIC1.
date_toYesEnd date, YYYY-MM-DD (inclusive).
sort_byNoRanking metric (default capture_fc).
date_fromYesStart date, YYYY-MM-DD (inclusive).
duration_bandNoOptional. Under 2 hours, 2 to 4 hours, or over 4 hours.
include_arrangementNoRank CONTRACTED and TOLLED units too (default false).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Return only the top N ranked rows (default all); total_ranked gives the full count.",
      +  "maximum": 200,
      +  "minimum": 1,
      +  "type": "integer"
      +}
  2. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already establish readOnly/idempotent/non-destructive, yet the description adds real behavioral context: the double fleet scan and resulting slowness/timeouts, the MLF-adjusted LP-solved-day basis of total_rev and why it diverges from get_battery_revenue's gross total, and the excluded bucket for commissioning/CONTRACTED/TOLLED units with the reason their spot revenue isn't their commercial return.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the ranking definition and the default metric, then the caveats, then the sibling pointer — a sensible order. It is a dense, clause-heavy paragraph with some nested parentheticals, but almost every clause carries decision-relevant information; trimming would lose the revenue-basis and exclusion warnings.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the full burden of describing returns, and it enumerates the row fields (rank, duid, station, region, capacity, duration_band, capture_fc_pct, capture_perfect_pct, rev_per_mw_day, rev_per_mwh_day, total_rev, cycles_per_day, movement) plus the excluded list. It also warns to check unit_class and peer_comparable before reading gaps as performance, covering the interpretation risk.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond it — notably why include_arrangement matters (spot revenue is not commercial return) and what movement/unit_class/peer_comparable mean for interpretation. It does not add syntax-level detail for region, dates or duration_band, leaving those entirely to the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific resource (league table of merchant NEM batteries over a date range) and a specific ranking basis (capture rate by default), then defines capture rate and capture_perfect_pct inline. It also names the sibling it is not — get_battery_revenue — for the single-unit case, so an agent can route correctly without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use (fleet-level rankings), when-not (per-unit revenue → get_battery_revenue), and an operational constraint (keep the range to a month or less because it scans the fleet twice and can time out). It also flags that CONTRACTED/TOLLED units are excluded unless include_arrangement is true, which is the key usage decision for this tool.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources