Skip to content

Commit ff76ef2

Browse files
authored
docs: update readme add contributors and release 0.3.0 (#9)
* docs: update reamde * chore: 0.3.0
1 parent 4659483 commit ff76ef2

File tree

2 files changed

+88
-2
lines changed

2 files changed

+88
-2
lines changed

README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,93 @@ Start the MCP server:
7777
npm run start
7878
```
7979

80+
# <img src="https://echarts.apache.org/zh/images/favicon.png" height="24"/> MCP ECharts ![](https://badge.mcpx.dev?type=server 'MCP Server') [![build](https://github.com/hustcc/mcp-echarts/actions/workflows/build.yml/badge.svg)](https://github.com/hustcc/mcp-echarts/actions/workflows/build.yml) [![npm Version](https://img.shields.io/npm/v/mcp-echarts.svg)](https://www.npmjs.com/package/mcp-echarts) [![smithery badge](https://smithery.ai/badge/@hustcc/mcp-echarts)](https://smithery.ai/server/@hustcc/mcp-echarts) [![npm License](https://img.shields.io/npm/l/mcp-echarts.svg)](https://www.npmjs.com/package/mcp-echarts)
81+
82+
Generate <img src="https://echarts.apache.org/zh/images/favicon.png" height="14"/> [Apache ECharts](https://echarts.apache.org/) diagram and chart with AI MCP dynamically. Using for chart generation and data analysis.
83+
84+
<a href="https://glama.ai/mcp/servers/@hustcc/mcp-echarts">
85+
<img width="380" height="200" src="https://glama.ai/mcp/servers/@hustcc/mcp-echarts/badge" alt="ECharts MCP server" />
86+
</a>
87+
88+
<div align="center">
89+
<img width="648" alt="mcp-echarts" src="https://mdn.alipayobjects.com/huamei_1gdzij/afts/img/A*s3w3SpMMPDQAAAAARzAAAAgAemB7AQ/original" />
90+
</div>
91+
92+
## ✨ Features
93+
94+
- Fully support all features and syntax of `ECharts`, include data, style, theme and so on.
95+
- Support exporting to `png`, `svg`, and `option` formats, with validation for `ECharts` to facilitate the model's multi-round output of correct syntax and graphics.
96+
- Lightweight, we can install it with `zero dependence`.
97+
- Extremely `secure`, fully generated locally, without relying on any remote services.
98+
99+
100+
## 🤖 Usage
101+
102+
To use with `Desktop APP`, such as Claude, VSCode, Cline, Cherry Studio, and so on, add the MCP server config below. On Mac system:
103+
104+
```json
105+
{
106+
"mcpServers": {
107+
"mcp-echarts": {
108+
"command": "npx",
109+
"args": [
110+
"-y",
111+
"mcp-echarts"
112+
]
113+
}
114+
}
115+
}
116+
```
117+
118+
On Window system:
119+
120+
```json
121+
{
122+
"mcpServers": {
123+
"mcp-echarts": {
124+
"command": "cmd",
125+
"args": [
126+
"/c",
127+
"npx",
128+
"-y",
129+
"mcp-echarts"
130+
]
131+
}
132+
}
133+
}
134+
```
135+
136+
Also, you can use it on aliyun, modelscope, glama.ai, smithery.ai or others with HTTP, SSE Protocol.
137+
138+
139+
## 🔨 Development
140+
141+
Install dependencies:
142+
143+
```bash
144+
npm install
145+
```
146+
147+
Build the server:
148+
149+
```bash
150+
npm run build
151+
```
152+
153+
Start the MCP server:
154+
155+
```bash
156+
npm run start
157+
```
158+
159+
160+
## 🧑🏻‍💻 Contributors
161+
162+
- [lyw405](https://github.com/lyw405): Supports 15+ charting MCP tool. [#2](https://github.com/hustcc/mcp-echarts/issues/2)
163+
- [BQXBQX](https://github.com/BQXBQX): Use @napi-rs/canvas instead node-canvas. [#3](https://github.com/hustcc/mcp-echarts/issues/3)
164+
- [hustcc](https://github.com/hustcc): Initial the repo.
165+
80166

81167
## 📄 License
82168

83-
MIT@[hustcc](https://github.com/hustcc).
169+
MIT@[hustcc](https://github.com/hustcc).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "mcp-echarts",
33
"description": "❤️ Generate visual charts using Apache ECharts with AI MCP dynamically.",
4-
"version": "0.2.0",
4+
"version": "0.3.0",
55
"main": "build/index.js",
66
"scripts": {
77
"test": "vitest",

0 commit comments

Comments
 (0)