Skip to main content
Glama
CoinStatsHQ

CoinStats MCP Server

Official

get-exchange-balance

Retrieve cryptocurrency balance data from connected exchanges to monitor portfolio holdings and track asset distribution.

Instructions

Get the balance data for a provided Exchange.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
connectionFieldsYesThe credentials given from exchange. key, secret etc.
connectionIdYesThe exchange connection id

Implementation Reference

  • The inline handler function registered for the 'get-exchange-balance' tool (and all API tools). It determines if local or API, then for API calls universalApiHandler with basePath, endpoint '/exchange/balance', 'POST', empty query params, and tool params as body.
    server.tool(config.name, config.description, config.parameters, async (params: Record<string, any>) => {
        // Handle local operations
        if (config.isLocal) {
            // Handle specific local tools
            if (config.name === 'save-share-token') {
                await saveToCache('shareToken', params.shareToken);
                return {
                    content: [
                        {
                            type: 'text',
                            text: 'Share token saved successfully',
                        },
                    ],
                };
            }
    
            if (config.name === 'get-share-token') {
                const shareToken = await getFromCache('shareToken');
    
                return {
                    content: [
                        {
                            type: 'text',
                            text: shareToken ? shareToken : 'No share token found in cache',
                            isError: !shareToken,
                        },
                    ],
                };
            }
            // Future local tools can be added here
    
            // Default response for unhandled local tools
            return {
                content: [
                    {
                        type: 'text',
                        text: 'Operation completed',
                    },
                ],
            };
        }
    
        // Handle API operations
        const basePath = config.basePath || COINSTATS_API_BASE;
        const method = config.method || 'GET';
    
        // Methods that typically have a request body
        const bodyMethods = ['POST', 'PUT', 'PATCH', 'DELETE'];
    
        // For GET/DELETE requests, all params go in the URL
        // For POST/PUT/PATCH, send params as the body
        if (bodyMethods.includes(method.toUpperCase())) {
            return universalApiHandler(basePath, config.endpoint, method, {}, params);
        } else {
            return universalApiHandler(basePath, config.endpoint, method, params);
        }
    });
  • ToolConfig defining the name, description, input schema (Zod validators for parameters), endpoint, and method for the 'get-exchange-balance' tool.
    {
        name: 'get-exchange-balance',
        description: 'Get the balance data for a provided Exchange.',
        endpoint: '/exchange/balance',
        method: 'POST',
        parameters: {
            connectionFields: z.object({}).describe('The credentials given from exchange. key, secret etc.'),
            connectionId: z.string().describe('The exchange connection id'),
        },
    },
  • src/index.ts:17-18 (registration)
    Invocation of registerTools with allToolConfigs, which registers the 'get-exchange-balance' tool on the MCP server.
    // Register all tools from configurations
    registerTools(server, allToolConfigs);
  • The registerTools function iterates over tool configs (including get-exchange-balance) and calls server.tool to register each tool with its handler.
    export function registerTools(server: McpServer, toolConfigs: ToolConfig<any>[]) {
        toolConfigs.forEach((config) => {
            server.tool(config.name, config.description, config.parameters, async (params: Record<string, any>) => {
                // Handle local operations
                if (config.isLocal) {
                    // Handle specific local tools
                    if (config.name === 'save-share-token') {
                        await saveToCache('shareToken', params.shareToken);
                        return {
                            content: [
                                {
                                    type: 'text',
                                    text: 'Share token saved successfully',
                                },
                            ],
                        };
                    }
    
                    if (config.name === 'get-share-token') {
                        const shareToken = await getFromCache('shareToken');
    
                        return {
                            content: [
                                {
                                    type: 'text',
                                    text: shareToken ? shareToken : 'No share token found in cache',
                                    isError: !shareToken,
                                },
                            ],
                        };
                    }
                    // Future local tools can be added here
    
                    // Default response for unhandled local tools
                    return {
                        content: [
                            {
                                type: 'text',
                                text: 'Operation completed',
                            },
                        ],
                    };
                }
    
                // Handle API operations
                const basePath = config.basePath || COINSTATS_API_BASE;
                const method = config.method || 'GET';
    
                // Methods that typically have a request body
                const bodyMethods = ['POST', 'PUT', 'PATCH', 'DELETE'];
    
                // For GET/DELETE requests, all params go in the URL
                // For POST/PUT/PATCH, send params as the body
                if (bodyMethods.includes(method.toUpperCase())) {
                    return universalApiHandler(basePath, config.endpoint, method, {}, params);
                } else {
                    return universalApiHandler(basePath, config.endpoint, method, params);
                }
            });
        });
    }
  • Universal API handler invoked by the tool handler to process path parameters, construct URL, make the HTTP request to CoinStats API, and format the response for MCP.
    export async function universalApiHandler<T>(
        basePath: string,
        endpoint: string,
        method: string = 'GET',
        params: Record<string, any> = {},
        body?: any
    ): Promise<{
        content: Array<{ type: 'text'; text: string; isError?: boolean }>;
    }> {
        try {
            // Handle path parameters - replace {paramName} in endpoint with actual values
            let processedEndpoint = endpoint;
            let processedParams = { ...params };
    
            // Find all path parameters in the endpoint (e.g., {coinId}, {id}, {type})
            const pathParamMatches = endpoint.match(/\{([^}]+)\}/g);
    
            if (pathParamMatches) {
                for (const match of pathParamMatches) {
                    const paramName = match.slice(1, -1); // Remove { and }
    
                    if (processedParams[paramName] !== undefined) {
                        // Replace the placeholder with the actual value
                        processedEndpoint = processedEndpoint.replace(match, processedParams[paramName]);
                        // Remove the parameter from query params since it's now part of the path
                        delete processedParams[paramName];
                    } else {
                        throw new Error(`Required path parameter '${paramName}' is missing`);
                    }
                }
            }
    
            // MCP clients might not support '~' in parameter names, so we replace '-' with '~' specifically for the /coins endpoint before making the request.
            if (endpoint === '/coins') {
                processedParams = Object.entries(processedParams).reduce((acc, [key, value]) => {
                    acc[key.replace(/-/g, '~')] = value;
                    return acc;
                }, {} as Record<string, any>);
            }
    
            const url = `${basePath}${processedEndpoint}`;
            const data = await makeRequestCsApi<T>(url, method, processedParams, body);
    
            if (!data) {
                return {
                    content: [{ type: 'text', text: 'Something went wrong', isError: true }],
                };
            }
    
            return {
                content: [
                    {
                        type: 'text',
                        text: JSON.stringify(data),
                    },
                ],
            };
        } catch (error) {
            return {
                content: [{ type: 'text', text: `Error: ${error}`, isError: true }],
            };
        }
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states what the tool does but doesn't describe how it behaves—such as whether it requires authentication (implied by connection parameters but not explicit), potential rate limits, error conditions, or what the output format looks like (no output schema).

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, efficient sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and appropriately sized for a simple retrieval tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of financial data retrieval, lack of annotations, and no output schema, the description is insufficient. It doesn't explain what 'balance data' includes (e.g., currencies, amounts), how results are structured, or any behavioral aspects like authentication needs or error handling, leaving significant gaps for an AI agent.

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?

Schema description coverage is 100%, so the schema already documents both parameters ('connectionFields' and 'connectionId') with descriptions. The tool description adds no additional meaning about parameters beyond what's in the schema, adhering to the baseline score for high coverage.

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 action ('Get') and resource ('balance data for a provided Exchange'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'get-wallet-balance' or 'get-wallet-balances' which also retrieve balance data but for different resources (wallets vs exchanges).

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. It doesn't mention sibling tools like 'get-exchange-transactions' or 'get-exchange-sync-status' that might be related, nor does it specify prerequisites such as needing an established exchange connection.

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/CoinStatsHQ/coinstats-mcp'

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