Elasticsearch/OpenSearch MCP 服务器项目教程

1. 项目的目录结构及介绍

项目的主要目录结构如下：

elasticsearch-mcp-server/
├── .github/              # GitHub 工作流文件
├── docker-compose-elasticsearch.yml  # Elasticsearch 使用的 Docker Compose 配置文件
├── docker-compose-opensearch.yml     # OpenSearch 使用的 Docker Compose 配置文件
├── src/                  # 源代码目录
│   ├── .env.example      # 环境变量配置示例文件
│   ├── Dockerfile        # Docker 构建文件
│   ├── LICENSE           # 许可证文件
│   ├── Makefile          # Makefile 文件
│   ├── README.md         # 项目说明文件
│   ├── cliff.toml        # cliff 文件
│   ├── pyproject.toml    # Python 项目配置文件
│   ├── smithery.yaml     # Smithery 配置文件
│   └── uv.lock           # uv.lock 文件

• .github/: 包含项目的工作流配置，例如自动化测试、构建等。
• docker-compose-elasticsearch.yml: 用于启动和配置 Elasticsearch 集群的 Docker Compose 文件。
• docker-compose-opensearch.yml: 用于启动和配置 OpenSearch 集群的 Docker Compose 文件。
• src/: 源代码目录，包含项目的核心代码和配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 Docker Compose 进行，以下为启动 Elasticsearch 集群的示例命令：

docker-compose -f docker-compose-elasticsearch.yml up -d

如果要启动 OpenSearch 集群，则使用以下命令：

docker-compose -f docker-compose-opensearch.yml up -d

这里 -d 参数表示以守护进程模式运行。

3. 项目的配置文件介绍

项目的主要配置文件包括：

• .env.example: 环境变量配置示例文件，需要将其复制为 .env 文件并进行相应的配置。

以下为 .env.example 文件的内容：

ELASTICSEARCH_HOSTS=https://localhost:9200
ELASTICSEARCH_USERNAME=elastic
ELASTICSEARCH_PASSWORD=test123

• Dockerfile: 用于构建项目的 Docker 镜像。

• pyproject.toml: Python 项目配置文件，定义了项目的依赖和构建系统。

在进行配置时，需要确保环境变量设置正确，以便于应用程序可以正确连接到 Elasticsearch 或 OpenSearch 集群。