Skip to content

Commit 0eed916

Browse files
author
huamihe
committed
enhance readme
1 parent 25866f9 commit 0eed916

File tree

2 files changed

+46
-43
lines changed

2 files changed

+46
-43
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -40,24 +40,40 @@ An Elasticsearch MCP (Model Context Protocol) server built on [github.com/mark3l
4040

4141
## Quick Start
4242

43-
### Using Docker (Recommended)
43+
Choose one of the following methods to run the Elasticsearch MCP server:
44+
45+
### Method 1: Build Docker Image (Recommended)
4446

4547
```bash
46-
# Start Elasticsearch and MCP server
47-
docker-compose up -d
48+
# Clone the repository
49+
git clone https://github.com/AeaZer/mcp-elasticsearch.git
50+
cd mcp-elasticsearch
51+
52+
# Build Docker image
53+
docker build -t mcp-elasticsearch .
4854

49-
# Or run just the MCP server
50-
docker run -e ES_ADDRESSES=http://localhost:9200 ghcr.io/aeazer/mcp-elasticsearch:latest
55+
# Run the container
56+
docker run -e ES_ADDRESSES=http://localhost:9200 -e ES_VERSION=8 mcp-elasticsearch
5157
```
5258

53-
### Manual Installation
59+
### Method 2: Use Pre-built Image (Coming Soon)
60+
61+
```bash
62+
# This will be available when the image is published to a registry
63+
# docker run -e ES_ADDRESSES=http://localhost:9200 ghcr.io/aeazer/mcp-elasticsearch:latest
64+
```
65+
66+
*Note: Pre-built images are not yet available. Please use Method 1 or Method 3.*
67+
68+
### Method 3: Compile from Source
5469

5570
```bash
5671
# Clone the repository
5772
git clone https://github.com/AeaZer/mcp-elasticsearch.git
5873
cd mcp-elasticsearch
5974

60-
# Build the application
75+
# Download dependencies and build
76+
go mod download
6177
go build -o mcp-elasticsearch main.go
6278

6379
# Run with environment variables
@@ -122,21 +138,6 @@ export ES_VERSION=8
122138
./mcp-elasticsearch
123139
```
124140

125-
## Docker Support
126-
127-
### Build from Source
128-
```bash
129-
docker build -t mcp-elasticsearch .
130-
```
131-
132-
### Run with Docker Compose
133-
```bash
134-
# Copy environment file
135-
cp env-example .env
136-
# Edit .env with your configuration
137-
# Start services
138-
docker-compose up -d
139-
```
140141

141142
## Development
142143

README_zh.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,24 +40,40 @@
4040

4141
## 快速开始
4242

43-
### 使用 Docker(推荐)
43+
选择以下任一方式运行 Elasticsearch MCP 服务器:
44+
45+
### 方式一:构建 Docker 镜像(推荐)
4446

4547
```bash
46-
# 启动 Elasticsearch 和 MCP 服务器
47-
docker-compose up -d
48+
# 克隆仓库
49+
git clone https://github.com/AeaZer/mcp-elasticsearch.git
50+
cd mcp-elasticsearch
51+
52+
# 构建 Docker 镜像
53+
docker build -t mcp-elasticsearch .
54+
55+
# 运行容器
56+
docker run -e ES_ADDRESSES=http://localhost:9200 -e ES_VERSION=8 mcp-elasticsearch
57+
```
58+
59+
### 方式二:使用预构建镜像(即将推出)
4860

49-
# 或仅运行 MCP 服务器
50-
docker run -e ES_ADDRESSES=http://localhost:9200 ghcr.io/aeazer/mcp-elasticsearch:latest
61+
```bash
62+
# 当镜像发布到仓库后将可用
63+
# docker run -e ES_ADDRESSES=http://localhost:9200 ghcr.io/aeazer/mcp-elasticsearch:latest
5164
```
5265

53-
### 手动安装
66+
*注意:预构建镜像尚未发布。请使用方式一或方式三。*
67+
68+
### 方式三:从源码编译
5469

5570
```bash
5671
# 克隆仓库
5772
git clone https://github.com/AeaZer/mcp-elasticsearch.git
5873
cd mcp-elasticsearch
5974

60-
# 构建应用程序
75+
# 下载依赖并构建
76+
go mod download
6177
go build -o mcp-elasticsearch main.go
6278

6379
# 使用环境变量运行
@@ -122,21 +138,7 @@ export ES_VERSION=8
122138
./mcp-elasticsearch
123139
```
124140

125-
## Docker 支持
126141

127-
### 从源码构建
128-
```bash
129-
docker build -t mcp-elasticsearch .
130-
```
131-
132-
### 使用 Docker Compose
133-
```bash
134-
# 复制环境文件
135-
cp env-example .env
136-
# 编辑 .env 配置文件
137-
# 启动服务
138-
docker-compose up -d
139-
```
140142

141143
## 开发
142144

0 commit comments

Comments
 (0)