Skip to content

Commit 1c16d00

Browse files
authored
chore: 0.4.0 (#16)
* chore: 0.4.0 * docs: update readme
1 parent a9739d4 commit 1c16d00

File tree

2 files changed

+24
-20
lines changed

2 files changed

+24
-20
lines changed

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Generate <img src="https://echarts.apache.org/zh/images/favicon.png" height="14"
1414

1515
- Fully support all features and syntax of `ECharts`, include data, style, theme and so on.
1616
- 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.
17-
- **MinIO Integration**: Store charts in MinIO object storage and return URLs instead of Base64 data for better performance and sharing capabilities.
18-
- Lightweight, we can install it with `zero dependence`.
17+
- MinIO Integration, store charts in `MinIO` object storage and return URLs instead of Base64 data for better performance and sharing capabilities.
18+
- Lightweight, we can install it easily with `zero dependence`.
1919
- Extremely `secure`, fully generated locally, without relying on any remote services.
2020

2121

@@ -55,15 +55,29 @@ On Window system:
5555
}
5656
```
5757

58-
Also, you can use it on aliyun, modelscope, glama.ai, smithery.ai or others with HTTP, SSE Protocol.
58+
Also, you can use it on [modelscope](https://www.modelscope.cn/mcp/servers/hustcc/MCP-ECharts), [glama.ai](https://glama.ai/mcp/servers/@hustcc/mcp-echarts), [smithery.ai](https://smithery.ai/server/@hustcc/mcp-echarts) or others with HTTP, SSE Protocol.
59+
5960

6061
## 🗂️ MinIO Configuration (Optional)
6162

6263
For better performance and sharing capabilities, you can configure MinIO object storage to store chart images as URLs instead of Base64 data.
6364

64-
### Setup MinIO
65+
> [!NOTE]
66+
> If MinIO is not configured or unavailable, the system automatically falls back to `Base64` data output, ensuring compatibility.
67+
68+
We can Integrate with `MinIO` object storage providers below.
69+
70+
- [MinIO](https://min.io/): High-performance, S3-compatible object storage. Use [MinIO JavaScript Client](https://min.io/docs/minio/linux/developers/javascript/minio-javascript.html) for direct integration.
71+
- [Amazon S3](https://aws.amazon.com/s3/): Use [AWS SDK](https://aws.amazon.com/sdk-for-javascript/) with compatible API endpoint.
72+
- [Alibaba Cloud OSS](https://www.alibabacloud.com/product/object-storage-service): Use the [Alibaba Cloud SDK](https://www.alibabacloud.com/help/en/sdk) for OSS services.
73+
- [Google Cloud Storage](https://cloud.google.com/storage): Integrate using [Google Cloud SDK](https://cloud.google.com/sdk) or compatible API.
74+
- [Microsoft Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs): Use [Azure SDK](https://azure.microsoft.com/en-us/downloads/) for Blob storage access.
75+
- [Tencent Cloud COS](https://intl.cloud.tencent.com/product/cos): Use the [Tencent Cloud SDK](https://intl.cloud.tencent.com/document/product/436/6474) for COS integration.
76+
77+
Also, we can setup MinIO locally for free.
6578

6679
1. **Install and start MinIO locally:**
80+
6781
```bash
6882
# Download MinIO (macOS example)
6983
brew install minio/stable/minio
@@ -72,7 +86,8 @@ For better performance and sharing capabilities, you can configure MinIO object
7286
minio server ~/minio-data --console-address :9001
7387
```
7488

75-
2. **Configure environment variables:**
89+
3. **Configure environment variables:**
90+
7691
```bash
7792
# Copy the example environment file
7893
cp .env.example .env
@@ -86,17 +101,6 @@ For better performance and sharing capabilities, you can configure MinIO object
86101
MINIO_BUCKET_NAME=mcp-echarts
87102
```
88103

89-
3. **Integration with Object Storage Providers:**
90-
- **[MinIO](https://min.io/)**: High-performance, S3-compatible object storage. Use [MinIO JavaScript Client](https://min.io/docs/minio/linux/developers/javascript/minio-javascript.html) for direct integration.
91-
- **[Amazon S3](https://aws.amazon.com/s3/)**: Use [AWS SDK](https://aws.amazon.com/sdk-for-javascript/) with compatible API endpoint.
92-
- **[Alibaba Cloud OSS](https://www.alibabacloud.com/product/object-storage-service)**: Use the [Alibaba Cloud SDK](https://www.alibabacloud.com/help/en/sdk) for OSS services.
93-
- **[Google Cloud Storage](https://cloud.google.com/storage)**: Integrate using [Google Cloud SDK](https://cloud.google.com/sdk) or compatible API.
94-
- **[Microsoft Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs)**: Use [Azure SDK](https://azure.microsoft.com/en-us/downloads/) for Blob storage access.
95-
- **[Tencent Cloud COS](https://intl.cloud.tencent.com/product/cos)**: Use the [Tencent Cloud SDK](https://intl.cloud.tencent.com/document/product/436/6474) for COS integration.
96-
### Fallback Behavior
97-
98-
If MinIO is not configured or unavailable, the system automatically falls back to `Base64` data output, ensuring compatibility.
99-
100104

101105
## 🔨 Development
102106

@@ -121,9 +125,9 @@ npm run start
121125

122126
## 🧑🏻‍💻 Contributors
123127

124-
- [lyw405](https://github.com/lyw405): Supports 15+ charting MCP tool. [#2](https://github.com/hustcc/mcp-echarts/issues/2)
125-
- [susuperli](https://github.com/susuperli): use MinIO to save the chart image base64 and return the url. [#10](https://github.com/hustcc/mcp-echarts/issues/10)
126-
- [BQXBQX](https://github.com/BQXBQX): Use @napi-rs/canvas instead node-canvas. [#3](https://github.com/hustcc/mcp-echarts/issues/3)
128+
- [lyw405](https://github.com/lyw405): Supports `15+` charting MCP tool. [#2](https://github.com/hustcc/mcp-echarts/issues/2)
129+
- [susuperli](https://github.com/susuperli): Use `MinIO` to save the chart image base64 and return the url. [#10](https://github.com/hustcc/mcp-echarts/issues/10)
130+
- [BQXBQX](https://github.com/BQXBQX): Use `@napi-rs/canvas` instead node-canvas. [#3](https://github.com/hustcc/mcp-echarts/issues/3)
127131
- [hustcc](https://github.com/hustcc): Initial the repo.
128132

129133

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.3.0",
4+
"version": "0.4.0",
55
"main": "build/index.js",
66
"scripts": {
77
"test": "vitest",

0 commit comments

Comments
 (0)