Skip to main content
Glama

Get sample credit balance

get_sample_balance
Read-onlyIdempotent

Retrieve the current sample credit balance for a shop to track available sample credits.

Instructions

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Returns the current sample credit balance for the shop

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoExact private shop profile label; not a provider identity or authorization proof.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so safety is covered. The description adds genuinely new behavioral context the annotations cannot convey: a concrete rate limit of 100 requests / 10 seconds per shop, plus a link to the rate-limiting guide.

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, zero waste. Slightly suboptimal ordering: the rate-limit note is front-loaded ahead of the one sentence that states what the tool actually does, which is the more important selection signal.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so nothing documents the return value beyond 'current sample credit balance for the shop' — no indication of units, currency, or whether it is a number or an object. For a trivial read-only zero-required-param tool this is adequate but not complete.

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 description coverage is 100% and the single 'account' parameter is documented in-schema as an exact private shop profile label. The description says nothing about the parameter, so baseline 3 applies — the schema does all the work and the description adds no syntax or scoping detail.

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 ('Returns the current sample credit balance for the shop'), which no sibling in the list covers — the surrounding tools deal with webhooks, products, collections, promotions, and giveaways, so there is no ambiguity to resolve. An agent can select it 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 Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no when-to-use guidance, no prerequisites, and names no alternative. The only operational guidance is a rate limit, which is a constraint rather than a usage condition.

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