get_balance
Current HOGSWAP credit balance for your API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Current HOGSWAP credit balance for your API key.
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavioral traits. It only implies a read-only operation but does not mention authentication, rate limits, response format, or side effects. The optional api_key parameter's behavior is not explained.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence that efficiently states the tool's purpose. It is not verbose, though it could add more value with additional context.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple, but with no annotations and no explanation of the api_key parameter or usage context, the description is not fully complete. It would benefit from a note on how the API key is sourced and when to use this instead of get_credit_offer.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description does not mention the api_key parameter at all, and schema description coverage is 0%. The schema shows an optional string/null parameter with a default of null, but the description does not clarify whether it overrides authentication or is required.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
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 distinguishes it from siblings like get_credit_offer or get_quote. However, it lacks an explicit verb (e.g., 'Gets'), making it slightly less direct.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
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, such as get_credit_offer, nor any exclusions or prerequisites. It solely states what it returns.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.