gate-local-mcp CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Commands

npm run build   # tsc → dist/ (required before npm start)
npm run dev     # run directly with tsx (no build step, useful during development)
npm start       # node dist/index.js

There are no tests configured. Type-checking happens via tsc during build.

Architecture

This is an MCP (Model Context Protocol) server that exposes the Gate.com REST API v4 to any MCP-compatible client over stdio.

Entry point (src/index.ts): creates an McpServer, calls all nine register*Tools() functions, then connects a StdioServerTransport. No HTTP server — communication is entirely over stdin/stdout.

Client (src/client.ts): createClient() instantiates a gate-api ApiClient using GATE_BASE_URL (default https://api.gateio.ws) and optionally sets API key/secret from GATE_API_KEY/GATE_API_SECRET. requireAuth() throws a descriptive error if credentials are absent — call it at the top of any private tool handler.

Utils (src/utils.ts): textContent(value) and errorContent(err) produce the standard MCP content response shapes. Every tool handler must return one of these — never throw to the MCP runtime.

Tool modules (src/tools/*.ts): each file exports a single register*Tools(server: McpServer): void function. Inside, tools are registered with server.tool(name, description, zodSchema, handler). Modules: spot, futures, delivery, margin, wallet, account, options, earn, flash_swap.

Publishing

Release flow (must follow this order):

1. Commit all changes
2. npm version patch — bumps version, creates git tag (requires clean working dir)
3. Update server.json version to match, commit
4. git push && git push --tags — triggers GitHub Actions to publish to npm automatically
5. After npm publish completes, remind the user to manually publish to the MCP registry:

   Run mcp-publisher login github then mcp-publisher publish — requires browser-based approval.