Skip to main content
Glama
Omnidim

@omnidim-ai/mcp-server

by Omnidim

getAccountBalance

Read-only

Check your organization's wallet balance, plan, concurrency headroom, and auto-recharge status before campaigns to avoid failed calls from insufficient credit.

Instructions

Read your organization's wallet: the remaining balance, the minutes it buys at your rates, your plan, your concurrency headroom, and whether auto-recharge will refill it.

Use it before a campaign, or on a schedule, so you find out you are low on credit from this endpoint rather than from a call failing with 402 payment_required.

The response always describes the organization the API key belongs to. There is no parameter for reading another account; resellers read a client's figures through the Reseller endpoints.

A balance at or below zero does not always mean calls will stop. An organization on usage-based billing (plan.is_usage_based) keeps placing calls and is metered to its payment method instead, so check that flag before treating a zero balance as a stop condition.

The API key's user needs Billing access in your organization. If you get a 403, an administrator can grant it when Billing is enabled for your organization; when it is not, contact support.

(Tags: Account)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.14.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only supply readOnlyHint/openWorldHint; the description adds real behavioral context the schema cannot: a zero balance does not always halt calls for usage-based billing orgs, and the call requires Billing access with a documented 403 remedy path. This is exactly the kind of non-obvious operational detail that prevents wrong agent conclusions.

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 what the call returns, then usage timing, then edge cases and auth. Every section earns its place, though the seven-paragraph layout is longer than strictly necessary and could be tightened without losing the 402/403/zero-balance guidance.

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 burden of describing the return payload and does so (balance, minutes, plan, concurrency, auto-recharge). Combined with scope, timing, and auth/error handling, an agent has everything needed to call it correctly and interpret results.

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?

Zero parameters, so the schema-based baseline of 4 applies. The description usefully clarifies that the absence of parameters is intentional and scope is fixed to the API key's organization, but there is no parameter syntax to document.

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 and resource ('Read your organization's wallet') and enumerates exactly what the payload contains: balance, minutes at your rates, plan, concurrency headroom, auto-recharge. No sibling tool covers account balance, and the description makes the scope unambiguous.

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 ('before a campaign, or on a schedule') with the rationale (surface low credit here rather than via a 402), and an explicit when-not/alternative ('there is no parameter for reading another account; resellers read a client's figures through the Reseller endpoints').

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