Skip to main content
Glama

Account balance

octopus_get_balance
Read-only

Retrieve an Octopus Energy account balance in pounds, overdue amount, and account status to check whether the account is in credit, owes money, or has overdue charges.

Instructions

Get the account balance in pounds (positive means in credit, negative means you owe Octopus), any overdue balance and the account status.

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_balance"
  }
}

Input Schema

NameRequiredDescriptionDefault
account_numberNoAccount number like A-1234ABCD (default OCTOPUS_ACCOUNT, or the only account the API key can see)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.1

TDQS

A3.7/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 genuine value beyond them by explaining the sign convention (positive = in credit, negative = you owe Octopus) and by disclosing that multiple values come back (balance, overdue balance, status) in the absence of an output schema.

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 definition is a single front-loaded sentence with no filler, and the sign convention is placed where it is immediately useful. It is slightly dense in packing three return items plus a parenthetical into one sentence, but no wording is wasted.

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 one-parameter read tool with full schema coverage and no output schema, the description carries the return-shape burden reasonably well by naming the three values returned. It does not explain possible account status values or error behavior for invalid account numbers, which keeps it short of complete.

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 coverage is 100% and the single account_number parameter is documented in the schema, complete with its default from OCTOPUS_ACCOUNT. The description adds nothing about the parameter, so baseline 3 applies.

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

Purpose4/5

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

The description uses a specific verb and resource ('Get the account balance') and further names the returned fields (overdue balance, account status). It never names a sibling tool, but the scope is narrow enough that confusion with tools like octopus_list_bills or octopus_get_account is unlikely.

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

Usage Guidelines3/5

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

Usage is only implied: an agent can infer this is the tool for checking money owed or in credit, but the description gives no explicit when-to-use condition, no prerequisites, and no pointer to alternatives such as transactions or bills for deeper financial detail.

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