Skip to main content
Glama

Account overview

octopus_get_account
Read-only

Retrieve an Octopus Energy account overview—properties, electricity and gas meter points, current tariffs, estimated annual consumption, and balance—to start account analysis.

Instructions

A one-call overview of the Octopus Energy account and a good first call: each property's address, its electricity meter points (MPAN, import or export, meter serial numbers, smart meter device IDs) and gas meter points (MPRN, serials, whether the meter reports in kWh or m³), the current tariff on each (tariff and product codes, region), the estimated annual consumption Octopus holds, and the account balance. Use the tariff codes with the tariffs tools, and the MPAN/MPRN and serials with octopus_get_consumption.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "octopus_get_account"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the REST account object unchanged instead of the summary
account_numberNoAccount number like A-1234ABCD (default OCTOPUS_ACCOUNT, or the only account the API key can see)
include_balanceNoInclude the account balance (default true)
include_historyNoAlso list previous tariffs and properties you have moved out of

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.1

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered; the description adds real substance by disclosing the breadth of the returned payload and noting that the raw flag bypasses the summary. It does not mention pagination, rate limits, or failure modes, and the idempotentHint=false annotation is left unexplained. No contradiction with annotations.

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?

The core value proposition and the 'good first call' cue are front-loaded, and each clause maps to a real returned field rather than filler. It is a single very long sentence, though, which makes the downstream-routing advice at the end easy to skim past.

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?

With no output schema, the description must carry the return-value burden, and it does so thoroughly by listing the payload contents. Gaps are minor: no indication of how large the response can be, how moved-out properties appear, or what happens when the API key sees multiple accounts.

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

Parameters3/5

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

Schema description coverage is 100%, so all four parameters (raw, account_number, include_balance, include_history) are already documented in the schema, including defaults. The description adds no parameter-level detail beyond implying that a summary is produced. Baseline 3 is appropriate.

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 verb+resource ('one-call overview of the Octopus Energy account') and then enumerates exactly what it returns: addresses, MPAN/MPRN meter points, serials, device IDs, tariff and product codes, region, EAC, and balance. That enumeration lets an agent tell it apart from octopus_get_balance, octopus_get_consumption, and the tariff tools without opening any schema.

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

Usage Guidelines4/5

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

Explicitly frames itself as 'a good first call' and routes the output onward ('use the tariff codes with the tariffs tools, and the MPAN/MPRN and serials with octopus_get_consumption'). It gives no exclusion guidance — e.g. nothing says to prefer octopus_get_balance when only the balance is needed — so it stops short of full when/when-not coverage.

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