Skip to main content
Glama

get_balance

Retrieve the current HOGSWAP credit balance for your API key.

Instructions

Current HOGSWAP credit balance for your API key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyNohsk_ API key override; omit to use the HOGSWAP_API_KEY env config
Behavior3/5

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

With no annotations, the description carries the full burden of disclosing behavior. The phrase 'Current balance' implies a read-only operation, but it does not explicitly state that it has no side effects, nor does it mention api key validity or error behavior. It provides minimal but acceptable transparency for a simple getter.

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 a single, front-loaded sentence with no wasted words. It conveys the essential information efficiently.

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 balance-check tool with one optional parameter and no output schema, the description is adequate. It identifies the resource (credit balance) and the scope (API key). It could mention the return format, but that is not critical for a straightforward getter.

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?

The schema covers the single parameter (api_key) with a description, and the tool description's reference to 'your API key' is redundant with the schema. With 100% schema coverage, the baseline of 3 applies, and the description adds no extra semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool returns the current HOGSWAP credit balance for the API key, which is a specific resource and action. It is implicit that this is a retrieval operation, and it is distinct from siblings like get_quote or build_swap, though it doesn't explicitly name alternatives.

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 provides no guidance on when to use this tool versus alternatives, no prerequisites, and no exclusion criteria. It is a bare statement of functionality without usage context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/LiquiHog/hogswap-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server