Skip to main content
Glama
jianchundev

Binance Cryptocurrency MCP

by jianchundev

get_order_book

Retrieve real-time order book data for cryptocurrency trading pairs on Binance to analyze market depth and liquidity.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
symbolYesTrading pair symbol, e.g. BTCUSDT
limitNoOrder book depth, default 100, max 5000

Implementation Reference

  • The handler function that executes the get_order_book tool logic. It makes an API call to Binance's /api/v3/depth endpoint with the provided symbol and limit parameters, uses proxy configuration, and returns the order book data as JSON or an error message.
    async (args: { symbol: string; limit?: number }) => {
        try {
            const response = await axios.get(`${BASE_URL}/api/v3/depth`, {
                params: {
                    symbol: args.symbol,
                    limit: args.limit
                },
                ...getProxyConfig(),
            });
            return {
                content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }]
            };
        } catch (error: any) {
            return {
                content: [{ type: "text", text: `Failed to get order book: ${error.message}` }],
                isError: true
            };
        }
    }
  • Input parameter schema definition using zod validation. Defines 'symbol' as a required string (trading pair) and 'limit' as an optional number (order book depth).
    {
        symbol: z.string().describe("Trading pair symbol, e.g. BTCUSDT"),
        limit: z.number().optional().describe("Order book depth, default 100, max 5000")
    },
  • src/index.ts:17-42 (registration)
    Tool registration with the MCP server using server.tool(). Registers the 'get_order_book' tool with its schema and handler function within the registerTools function.
    server.tool(
        "get_order_book",
        {
            symbol: z.string().describe("Trading pair symbol, e.g. BTCUSDT"),
            limit: z.number().optional().describe("Order book depth, default 100, max 5000")
        },
        async (args: { symbol: string; limit?: number }) => {
            try {
                const response = await axios.get(`${BASE_URL}/api/v3/depth`, {
                    params: {
                        symbol: args.symbol,
                        limit: args.limit
                    },
                    ...getProxyConfig(),
                });
                return {
                    content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }]
                };
            } catch (error: any) {
                return {
                    content: [{ type: "text", text: `Failed to get order book: ${error.message}` }],
                    isError: true
                };
            }
        }
    );
  • Helper function that provides proxy configuration for axios requests. Supports SOCKS5 and HTTP proxies based on environment variables (SOCKS_PROXY, SOCKS5_PROXY, HTTP_PROXY, HTTPS_PROXY).
    function getProxyConfig(): any {
        // 优先使用SOCKS5代理
        if (socksProxyURL) {
            try {
                const agent = new SocksProxyAgent(socksProxyURL);
                return { httpsAgent: agent, httpAgent: agent };
            } catch (error) {
                console.error(`Failed to create SOCKS proxy agent: ${error}`);
            }
        }
        
        // 回退到HTTP代理
        if (httpProxyURL) {
            try {
                const urlInfo = new URL(httpProxyURL);
                return {
                    proxy: {
                        host: urlInfo.hostname,
                        port: parseInt(urlInfo.port) || (urlInfo.protocol === 'https:' ? 443 : 80),
                        protocol: urlInfo.protocol.replace(":", "")
                    }
                };
            } catch (error) {
                console.error(`Failed to parse HTTP proxy URL: ${error}`);
            }
        }
        
        return {};
    }
Behavior1/5

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

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

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

Completeness1/5

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

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

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

Purpose1/5

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

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

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/jianchundev/binance-mcp'

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