Skip to main content
Glama

Read plan and credits

read_credits
Read-onlyIdempotent

Show the signed-in user's Vidova plan and credits: the balance, what a new request can spend (available), when the plan's next credits come and how many (renewsAt, renewalCredits; null when none are coming), when the credits run out at the last 7 days' pace (runsOutAt; null when nothing was spent in them), the plan's usage this month as shares on Creator, Pro and Studio (usage), what was spent this period by category, whether the person can add credits, and the credit price of each action. The agent, video, images, music, voice, analysis, video search and cloud renders all spend from this one balance. Check it before costly work such as a long video or music generation.

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": "read_credits"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
noteYes
planYes
weekNo
spentYes
usageNo
pricesYes
balanceYes
renewsAtYes
availableYes
runsOutAtYes
unlimitedYes
canAddCreditsYes
renewalCreditsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedOutput schema / properties / usage
      Added value: +{
      +  "properties": {
      +    "allowanceCredits": {
      +      "type": "number"
      +    },
      +    "extraCredits": {
      +      "type": "number"
      +    },
      +    "leftPercent": {
      +      "type": "number"
      +    },
      +    "period": {
      +      "enum": [
      +        "week",
      +        "month"
      +      ],
      +      "type": "string"
      +    },
      +    "resetsAt": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "rolledOverPercent": {
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "period",
      +    "leftPercent",
      +    "rolledOverPercent",
      +    "resetsAt",
      +    "extraCredits",
      +    "allowanceCredits"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedOutput schema / properties / week
      Added value: +{
      +  "properties": {
      +    "allowanceCredits": {
      +      "type": "number"
      +    },
      +    "extraCredits": {
      +      "type": "number"
      +    },
      +    "leftPercent": {
      +      "type": "number"
      +    },
      +    "resetsAt": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    }
      +  },
      +  "required": [
      +    "leftPercent",
      +    "resetsAt",
      +    "extraCredits",
      +    "allowanceCredits"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so safety is covered. The description adds genuine context beyond them: the null-semantics of renewsAt/renewalCredits and runsOutAt, and the fact that a single balance funds every generator. It still omits any note on cost, latency or failure modes for what is a cheap read, so this lands at adequate rather than rich.

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

Conciseness3/5

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

The core purpose is front-loaded and the guidance sentence lands at the end, which is good ordering. But the middle is one long run-on clause enumerating every output field, duplicating the output schema and making the text heavier than it needs to be for an agent deciding whether to call it.

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 zero-parameter read with full annotations and an output schema, the description covers purpose, null-value edge cases, the shared-balance model and a usage trigger — enough to call it correctly. The field-by-field enumeration is redundant with the output schema, so a 5 for adding only value beyond structure isn't warranted.

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?

The tool takes zero parameters, so the baseline is 4. The description spends its words on return fields, which the output schema already documents, rather than on parameter meaning; there is nothing to clarify here.

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 opens with a specific verb and resource ('Show the signed-in user's Vidova plan and credits') and then enumerates the exact data returned: balance, available, renewsAt, renewalCredits, runsOutAt, monthly usage shares, per-category spend, top-up eligibility and per-action credit prices. An agent can distinguish this from siblings like read_points or whoami 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 a concrete trigger — 'Check it before costly work such as a long video or music generation' — which tells the agent when to call. It does not name an alternative or state when this call is unnecessary, so there is no explicit exclusion guidance, keeping it below a 5.

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.