Skip to main content
Glama
outscraper

Outscraper MCP

Official
by outscraper

Outscraper Balance

balance_get

Check Outscraper account balance and billing summary to confirm your API key is funded and ready for large extraction jobs.

Instructions

Fetch the current Outscraper account balance and billing summary for the active API key.

Best for:

  • checking whether the key is attached to a funded account

  • confirming account status before running larger jobs

  • reading upcoming invoice and usage billing details

Use this when:

  • you want a quick health check for the current API key/account

  • you need to confirm available balance before large async jobs

  • you are debugging whether billing or account status might explain API behavior

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
metaYes
asyncNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.5
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.2.3

TDQS

A4.3/5.0
Behavior3/5

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

Annotations are not provided, so the description bears the full burden of behavioral disclosure. It states it 'fetches' a balance, implying read-only, but does not explicitly confirm that it is side-effect-free, does not consume credits, or how it handles invalid keys. The reference to the active API key adds useful context, but the transparency is incomplete.

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?

The description is well-structured with a clear lead sentence and bullet-point lists. However, the 'Best for' and 'Use this when' sections overlap in content (e.g., 'checking whether the key is attached to a funded account' vs. 'quick health check'), introducing some redundancy. It is not verbose but could be tightened without losing value.

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 simple tool with no parameters and an output schema likely documenting return fields, the description adequately covers the purpose, usage scenarios, and the reliance on the active API key. The only missing element is an explicit read-only confirmation, which is minor given the tool's nature.

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 has zero parameters, so the schema is empty and fully covered. The description correctly omits parameter explanations that are unnecessary. The mention of 'active API key' is contextual, not a parameter, and does not conflict with the schema.

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 first sentence clearly states the action (fetch), the resource (current Outscraper account balance and billing summary), and the scope (active API key). It is immediately distinct from all sibling tools, which are focused on data scraping, searching, and review retrieval. No ambiguity exists about what this tool does.

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?

Explicit 'Best for' and 'Use this when' sections provide concrete scenarios: checking funded status, confirming before large jobs, and debugging billing issues. Although no alternatives are mentioned, none exist among siblings, so the guidance is sufficiently directive. The usage contexts are practical and actionable.

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