Skip to main content
Glama

Actual vs optimal dispatch revenue

get_battery_optimal
Read-onlyIdempotent

Actual vs LP-optimal dispatch revenue, per-DUID summary, over a date range (energy-only, perfect-foresight benchmark). NOT a revenue-total source — use get_battery_revenue for that. Both the 'actual' AND the 'optimal' figures here are MLF-adjusted (get_battery_revenue's is gross) — the LP's objective is solved on MLF-adjusted prices, not just settled at them afterward — and both cover solved LP days only (days where the solver failed are dropped from both), so the two tools' totals will not match even for the same DUID and date range. The requested date_to may also be silently truncated to the latest date with sufficient fleet-wide LP coverage. Pass duid to restrict to one battery — omitting it scans every DUID and can time out even on a ~3-week range; even a single-DUID, single-month scan has been observed to time out, so keep date ranges short and retry narrower on a timeout.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
duidNoBattery DUID, e.g. HPR1 (optional — omit for all DUIDs)
date_toYesEnd date, YYYY-MM-DD (inclusive).
date_fromYesStart date, YYYY-MM-DD (inclusive).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • changedInput schema / properties / date_from / description
      Previous value: -"Start date YYYY-MM-DD"New value: +"Start date, YYYY-MM-DD (inclusive)."
    • addedInput schema / properties / date_from / format
      Added value: +"date"
    • changedInput schema / properties / date_to / description
      Previous value: -"End date YYYY-MM-DD"New value: +"End date, YYYY-MM-DD (inclusive)."
    • addedInput schema / properties / date_to / format
      Added value: +"date"
  2. Changed1 schema field changed
    • addedInput schema / properties / duid
      Added value: +{
      +  "description": "Battery DUID, e.g. HPR1 (optional — omit for all DUIDs)",
      +  "type": "string"
      +}
  3. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations cover the safety profile (readOnly, idempotent, non-destructive), but the description adds substantial behavior beyond them: MLF-adjusted vs gross figures, both totals restricted to solved LP days, the two tools' totals intentionally not matching, silent truncation of date_to, and observed timeout behavior even for single-DUID single-month scans.

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-loads the core purpose before the caveats, and nearly every clause carries non-obvious information. The heavy em-dash parentheticals make it dense and slightly harder to parse, but there is little waste.

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

Completeness4/5

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

For a read-only, 3-param tool with no output schema, the description covers purpose, exclusions, comparison caveats, and failure modes well. It is slightly thin on the actual return shape (per-DUID summary is named but not itemized), which is the only notable gap.

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 baseline is 3, but the description adds real meaning: omitting duid scans every DUID and can time out, while passing it restricts to one battery. Date parameters are only constrained generically ('keep date ranges short'), and the date_to truncation caveat is a useful semantic addition.

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 and comparison (actual vs LP-optimal dispatch revenue) with a defined scope (per-DUID, date range, energy-only, perfect-foresight benchmark). It explicitly names the sibling it is NOT (get_battery_revenue) and why, so an agent can disambiguate without opening schemas.

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?

Explicitly says when not to use it ('NOT a revenue-total source — use get_battery_revenue') and when to pass duid (omit for fleet scan, but risks timeouts). It gives concrete operational guidance: keep date ranges short, retry narrower on timeout.

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