Skip to main content
Glama

channel_balance

Check a prepaid channel’s remaining Bitcoin BSV balance, spend, and request count. Uses the Authorization header or apiKey. On failure returns isError "error: (): ": no_channel_key, or invalid_channel (401/404: not found, bad secret, or closed).

Input Schema

NameRequiredDescriptionDefault
apiKeyNochannelId:channelSecret. Omit to use the Authorization header (preferred).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the two auth paths, the exact error envelope (isError "error: <code> (<status>): <message>"), and the specific failure codes no_channel_key and invalid_channel with their 401/404 causes (not found, bad secret, closed). It stops short of stating that the call is read-only or whether it consumes quota.

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?

Two sentences, front-loaded with what the tool returns, then auth, then error semantics. Dense but every clause carries information; the error-code parenthetical is slightly compressed but earns its place.

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?

No output schema exists, and the description compensates by enumerating the returned fields (balance, spend, request count) and the failure contract. An agent could call this correctly from the description alone; only quota/rate-limit and read-only status are unaddressed.

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 parameter already documents the channelId:channelSecret format and the 'omit to use Authorization header (preferred)' rule. The description's auth sentence largely restates that, adding no new syntax or format detail, so the 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?

States a specific verb (check) and resource (prepaid channel balance) plus the exact fields returned: remaining Bitcoin BSV balance, spend, and request count. The resource is clearly distinct from siblings like open_channel or infer, though no sibling is named explicitly.

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?

The description covers the auth choice (Authorization header preferred over apiKey) but never says when to reach for this tool versus open_channel or the infer variants, nor any preconditions beyond having a channel key. Usage is implied rather than stated.

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.