mcp-echarts

MCP ECharts is a server that lets you generate Apache ECharts charts and analyses via the MCP (Model Context Protocol) workflow. It supports generating charts, exporting to formats like PNG and SVG, and can store chart assets in MinIO for easy sharing via URLs. The server can operate over standard IO, SSE, or a streaming HTTP transport, making it usable from desktop apps, model scopes, or HTTP-based clients. The package exposes a CLI with various transport options and a small API for configuring the MinIO-backed storage and chart rendering pipeline.

To run it, install the package globally and launch the server with the desired transport. You can then connect using the provided endpoints (for example /sse for SSE or /mcp for streamable) and send chart requests via the MCP protocol. The CLI and runtime options let you specify the transport, port, and endpoint so you can tailor it to your environment.

Prerequisites:

• Node.js 18 or higher
• npm (comes with Node.js)

Install and run locally:

# Install globally (preferred for quick testing)
npm install -g mcp-echarts

# Run the server (default transport is stdio; use --transport/ -t to switch to SSE/streamable if supported)
mcp-echarts -t sse

Alternatively, build from source and run locally:

# Clone the repository and install dependencies
git clone https://github.com/hustcc/mcp-echarts.git
cd mcp-echarts
npm install

# Build the server
npm run build

# Start the MCP server
npm run start

If you prefer the MCP as a one-off node process without a global install, you can also run via npx as shown in the mcp_config.

Tips and notes:

• Prerequisites mention Node.js 18+. Ensure your environment uses a compatible Node.js version.
• MinIO is optional but recommended for URL-based sharing of chart assets. If MinIO is not configured, outputs fall back to Base64 data.
• If you’re using the SSE or streamable transports, ensure the appropriate port is open in your firewall and that any reverse proxy rules route the /sse or /mcp endpoints correctly.
• Environment variables for MinIO (when enabled) include MINIO_ENDPOINT, MINIO_PORT, MINIO_USE_SSL, MINIO_ACCESS_KEY, MINIO_SECRET_KEY, and MINIO_BUCKET_NAME. See the README for example .env setup.
• The server exports charts via MinIO URLs when configured; otherwise, results are returned as standard data payloads. Check logs for any storage initialization errors.