Skip to main content
Glama

check_balance

Check your LightningProx balance in satoshis to pay for Polymarket prediction market analyses on the Bitcoin Lightning network.

Instructions

Check your LightningProx balance in sats. Required to pay for LPXPoly analyses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler implementation for the "check_balance" tool in the switch-case block of the MCP tool request handler.
    case "check_balance": {
      const balance = await getBalance();
    
      return {
        content: [
          {
            type: "text",
            text: [
              `⚡ LightningProx Balance`,
              `Balance: ${balance.balance_sats} sats`,
              `Estimated analyses remaining: ~${Math.floor(balance.balance_sats / 50)}`,
              ``,
              balance.balance_sats > 0
                ? `✅ Ready for market analysis`
                : `⚠️  No balance. Top up at ${LIGHTNINGPROX_URL}`,
            ].join("\n"),
          },
        ],
      };
    }
  • A helper function that performs the API call to LightningProx to retrieve the user's balance.
    async function getBalance(): Promise<any> {
      const res = await fetch(`${LIGHTNINGPROX_URL}/v1/balance`, {
        headers: { "X-Spend-Token": SPEND_TOKEN },
      });
      if (!res.ok) throw new Error(`Failed to fetch balance: ${res.statusText}`);
      return res.json();
    }
  • src/index.ts:69-77 (registration)
    The tool registration definition for "check_balance" within the tools array.
      name: "check_balance",
      description:
        "Check your LightningProx balance in sats. Required to pay for LPXPoly analyses.",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses that this is a read operation ('Check') and hints at a prerequisite for analyses, but lacks details on authentication needs, rate limits, error conditions, or return format. For a tool with no annotations, this is a moderate gap, scoring 3 as it provides basic behavioral context but misses key operational details.

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 concise sentences with zero waste. The first sentence states the purpose, and the second adds crucial usage context. Every word earns its place, making it highly efficient and well-structured.

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?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is reasonably complete for its purpose. However, it lacks details on return values (e.g., balance format, units) and doesn't fully address behavioral aspects like error handling. For a balance-checking tool, this is adequate but leaves some gaps, scoring 3.

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 0 parameters, and schema description coverage is 100% (as there are no parameters to describe). The description doesn't need to add parameter semantics, so it meets the baseline of 4 for zero-parameter tools. No additional value is required or provided beyond the schema.

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's purpose: 'Check your LightningProx balance in sats.' It specifies the verb ('Check') and resource ('LightningProx balance'), and distinguishes it from siblings by focusing on balance rather than market analysis or opportunities. However, it doesn't explicitly differentiate from hypothetical similar tools like 'get_balance' or 'view_balance', keeping it at 4 instead of 5.

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 provides clear context for when to use the tool: 'Required to pay for LPXPoly analyses.' This implies it should be used before or during payment-related operations for analyses. It doesn't explicitly state when NOT to use it or name alternatives among siblings, but the context is sufficiently clear for a 4.

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/unixlamadev-spec/lpxpoly-mcp'

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