Skip to main content
Glama
vobiz-ai

Vobiz MCP Server

Official
by vobiz-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get account balance

get_account_balance
Read-only

Retrieve wallet balances for your Vobiz account, including available funds, reserved amounts, credit limit, postpaid status, and currency details; pass a currency to view one wallet.

Instructions

Return this account's wallet balance (GET /balance): balance, available_balance, reserved_funds, credit_limit, is_postpaid and status, per currency. Without currency every wallet is returned in balances (accounts can be billed in INR, USD or other currencies) and the first one is repeated as balance; with currency only that wallet is returned as balance. For the charges and top-ups behind the balance use list_transactions.

Input Schema

NameRequiredDescriptionDefault
currencyNoISO 4217 code of one wallet, e.g. INR or USD (case-insensitive). Omit to return every wallet.

Output Schema

NameRequiredDescriptionDefault
okNoTrue on success; false when the result is an error (then error, message and retryable are set).
countNoNumber of wallets returned; present only when currency was omitted.
balanceNoThe requested wallet, or the first wallet when currency was omitted (null when the account has none).
balancesNoEvery wallet on the account; present only when currency was omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • changedInput schema / properties / currency / description
      Previous value: -"ISO currency code, e.g. INR or USD. Omit to list every wallet."New value: +"ISO 4217 code of one wallet, e.g. INR or USD (case-insensitive). Omit to return every wallet."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "balance": {
+      "description": "The requested wallet, or the first wallet when currency was omitted (null when the account has none)."
+    },
+    "balances": {
+      "description": "Every wallet on the account; present only when currency was omitted.",
+      "items": {
+        "description": "One wallet: currency, balance, available_balance, reserved_funds, promotional_balance, credit_limit, credit_limit_type, is_postpaid, low_balance_threshold, status."
+      },
+      "type": "array"
+    },
+    "count": {
+      "description": "Number of wallets returned; present only when currency was omitted.",
+      "type": "number"
+    },
+    "ok": {
+      "description": "True on success; false when the result is an error (then error, message and retryable are set).",
+      "type": "boolean"
+    }
+  },
+  "type": "object"
+}
  2. First observedv1.1.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish readOnlyHint and openWorldHint, so the safety profile is covered. The description adds real behavioral nuance beyond that: when no currency is given the first wallet is repeated as `balance`, and billing can span INR/USD or other currencies — details an agent would otherwise have to discover empirically.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Dense but orderly: the endpoint and return fields are front-loaded, the currency conditional follows, and the sibling pointer closes it out. No sentence is filler.

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?

For a one-parameter read tool with an output schema present, the description supplies everything an agent needs: what comes back, how the currency flag changes the shape, and where to go for related data. Nothing material is missing.

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% and the single parameter is fully documented, so the baseline is 3. The description goes further by explaining the observable effect of omitting currency (all wallets plus a duplicated first entry in `balance`), which is semantic behavior the schema does not state.

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?

The description gives a specific verb and resource ('Return this account's wallet balance'), names the endpoint, and enumerates the returned fields. It also differentiates itself from list_transactions, so an agent can place it among the account-related siblings without opening the 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?

It gives clear conditional guidance for the two call modes (omit currency to get all wallets, supply currency for one) and routes the agent to list_transactions for the charges and top-ups behind the balance. No explicit 'when not to use' case is stated, but the practical context is well covered.

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

Deploy Server

Other Tools