Skip to main content
Glama

SocialCrawl

Check SocialCrawl Credit Balance

socialcrawl_check_balance
Read-onlyIdempotent

Check the credit balance and the credit ledger for the authenticated SocialCrawl account. Default view calls GET /v1/credits/balance (balance + recent-deduction summary); view: "transactions" calls GET /v1/credits/transactions for dispute-grade itemised receipts — every deduction and refund with its amount, balance_after, endpoint, and request_id, which is how you confirm what a metered endpoint actually charged after its upfront hold was refunded down. Both cost 0 credits. Requires a valid SOCIALCRAWL_API_KEY.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
viewNo'balance' (default) returns the current credit balance and recent-deduction summary. 'transactions' returns the itemised credit ledger — every deduction and refund keyed by request_id, which is how you confirm what a metered endpoint actually charged after its upfront hold was refunded.
limitNotransactions: page size (1-100, default 50).
cursorNotransactions: opaque keyset cursor from a previous response's next_cursor.
requestIdNotransactions: fetch the receipt(s) for one request id (e.g. 'req-a1b2c3d4e5f6').

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnlyHint and idempotentHint annotations, the description discloses meaningful behavior: the exact GET endpoints, that "both cost 0 credits," that a valid SOCIALCRAWL_API_KEY is required, and the ledger semantics including upfront holds being refunded down. This goes well beyond what annotations alone convey.

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?

The description is two dense sentences with no filler. It front-loads the core purpose, then delivers endpoint details, use-case guidance, cost, and authentication requirements in a compact, readable structure.

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?

Even without an output schema, the description covers what each view returns, when to use each, cost, authentication, and the purpose of the ledger. The schema covers pagination details via cursor and limit, so nothing essential for calling the tool correctly 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%, so the parameters are already well documented. The description adds value by explaining the purpose of the view switch and how request_id relates to confirming actual metered charges, but it does not add additional semantics for limit or cursor beyond what the schema already provides.

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 states a clear, specific action: "Check the credit balance and the credit ledger for the authenticated SocialCrawl account." It additionally names the two underlying endpoints, making the tool's scope unmistakable and easily distinguishable from siblings like socialcrawl_request or socialcrawl_pricing.

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?

The description clearly explains when to use the balance view versus the transactions view, especially for "dispute-grade itemised receipts" and confirming what a metered endpoint actually charged. It does not explicitly contrast this tool with sibling tools, but the siblings are functionally distinct enough that the internal view guidance is the main decision point.

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.