Skip to content

Commit 25866f9

Browse files
author
huamihe
committed
enhance README
1 parent 714e26f commit 25866f9

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ An Elasticsearch MCP (Model Context Protocol) server built on [github.com/mark3l
88

99
## Features
1010

11-
- 🔗 **Multi-Protocol Support**: Supports both stdio and HTTP protocols
11+
- 🔗 **Multi-Protocol Support**: Supports both stdio and Streamable HTTP protocols
1212
- 📊 **Multi-Version Compatibility**: Compatible with Elasticsearch 7, 8, and 9
1313
- ⚙️ **Environment Configuration**: Configure via environment variables
1414
- 🔧 **Rich Toolset**: Complete set of Elasticsearch operation tools
@@ -93,8 +93,8 @@ All configuration is done via environment variables:
9393
| `MCP_SERVER_NAME` | Server name for MCP | `Elasticsearch MCP Server` |
9494
| `MCP_SERVER_VERSION` | Server version | `1.0.0` |
9595
| `MCP_PROTOCOL` | Protocol to use (`stdio` or `http`) | `stdio` |
96-
| `MCP_ADDRESS` | HTTP server address (HTTP mode only) | `localhost` |
97-
| `MCP_PORT` | HTTP server port (HTTP mode only) | `8080` |
96+
| `MCP_ADDRESS` | Streamable HTTP server address (HTTP mode only) | `localhost` |
97+
| `MCP_PORT` | Streamable HTTP server port (HTTP mode only) | `8080` |
9898

9999
## Usage Examples
100100

@@ -105,7 +105,7 @@ export MCP_PROTOCOL=stdio
105105
./mcp-elasticsearch
106106
```
107107

108-
### HTTP Mode
108+
### Streamable HTTP Mode
109109
```bash
110110
export ES_ADDRESSES=http://localhost:9200
111111
export MCP_PROTOCOL=http

README_zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## 功能特性
1010

11-
- 🔗 **多协议支持**: 支持 stdio 和 HTTP 协议
11+
- 🔗 **多协议支持**: 支持 stdio 和 Streamable HTTP 协议
1212
- 📊 **多版本兼容**: 兼容 Elasticsearch 7、8、9 版本
1313
- ⚙️ **环境变量配置**: 通过环境变量进行配置
1414
- 🔧 **丰富工具集**: 完整的 Elasticsearch 操作工具
@@ -93,8 +93,8 @@ export MCP_PROTOCOL=stdio
9393
| `MCP_SERVER_NAME` | MCP 服务器名称 | `Elasticsearch MCP Server` |
9494
| `MCP_SERVER_VERSION` | 服务器版本 | `1.0.0` |
9595
| `MCP_PROTOCOL` | 使用的协议(`stdio``http`| `stdio` |
96-
| `MCP_ADDRESS` | HTTP 服务器地址(仅 HTTP 模式) | `localhost` |
97-
| `MCP_PORT` | HTTP 服务器端口(仅 HTTP 模式) | `8080` |
96+
| `MCP_ADDRESS` | Streamable HTTP 服务器地址(仅 HTTP 模式) | `localhost` |
97+
| `MCP_PORT` | Streamable HTTP 服务器端口(仅 HTTP 模式) | `8080` |
9898

9999
## 使用示例
100100

@@ -105,7 +105,7 @@ export MCP_PROTOCOL=stdio
105105
./mcp-elasticsearch
106106
```
107107

108-
### HTTP 模式
108+
### Streamable HTTP 模式
109109
```bash
110110
export ES_ADDRESSES=http://localhost:9200
111111
export MCP_PROTOCOL=http

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Package main implements the Elasticsearch MCP (Model Context Protocol) server
22
// that provides an interface for interacting with Elasticsearch clusters
3-
// through both stdio and HTTP protocols.
3+
// through both stdio and Streamable HTTP protocols.
44
package main
55

66
import (

server/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Package server implements the MCP server functionality for Elasticsearch integration.
2-
// It provides both stdio and HTTP protocol support for the Model Context Protocol.
2+
// It provides both stdio and Streamable HTTP protocol support for the Model Context Protocol.
33
package server
44

55
import (

0 commit comments

Comments
 (0)