Back to Tool Reference
MCP

credits.check

Inspect the caller's credit wallet.

Effectread-onlyScopecredits:read

Parameters

requiredintegerDefault: 0

Optional credit amount to test against the balance. When provided, sufficient reflects whether the org can afford it. 0 just returns the current balance.

Returns

balancenumber

Current credit balance for your organization.

requirednumber

Echo of the required argument.

sufficientboolean

Whether balance >= required. true when required is 0.

Request
json
{
  "name": "credits.check",
  "arguments": {}
}
Response
json
{
  "balance": 196,
  "required": 0,
  "sufficient": true,
  "billing_mode": "org_pays"
}