elasticsearch-mcp-server 1.0.0__tar.gz → 2.0.0__tar.gz

elasticsearch_mcp_server-2.0.0/.env.example

@@ -0,0 +1,9 @@
+# Elasticsearch connection settings
+ELASTICSEARCH_HOSTS=https://localhost:9200
+ELASTICSEARCH_USERNAME=elastic
+ELASTICSEARCH_PASSWORD=test123
+
+# OpenSearch connection settings
+OPENSEARCH_HOSTS=https://localhost:9200
+OPENSEARCH_USERNAME=admin
+OPENSEARCH_PASSWORD=admin

elasticsearch_mcp_server-2.0.0/.github/workflows/pypi-publish.yaml

@@ -0,0 +1,51 @@
+# This workflow will upload Python Packages using uv when a release is created
+# It builds and publishes two separate packages: elasticsearch-mcp-server and opensearch-mcp-server
+
+name: PyPI Publish
+
+on:
+  workflow_run:
+    workflows: ["Release"]
+    types:
+      - completed
+
+env:
+  UV_PUBLISH_TOKEN: '${{ secrets.PYPI_API_TOKEN }}'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install uv
+        uv sync
+
+    # First build and publish elasticsearch-mcp-server
+    - name: Build elasticsearch-mcp-server package
+      run: uv build
+        
+    - name: Publish elasticsearch-mcp-server package
+      run: uv publish
+      
+    # Clean up dist directory
+    - name: Clean dist directory
+      run: rm -rf dist/*
+      
+    # Then build and publish opensearch-mcp-server
+    - name: Build opensearch-mcp-server package
+      run: |
+        # Change package name to opensearch-mcp-server
+        sed -i 's/^name = .*$/name = "opensearch-mcp-server"/' pyproject.toml
+        uv build
+        
+    - name: Publish opensearch-mcp-server package
+      run: uv publish

elasticsearch_mcp_server-2.0.0/.gitignore

@@ -0,0 +1,12 @@
+# IDE
+.idea
+.vscode
+
+# Python
+.venv
+dist
+__pycache__
+*.egg-info
+
+# Configuration and Credentials
+.env

elasticsearch_mcp_server-2.0.0/Dockerfile

@@ -0,0 +1,30 @@
+# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
+# Start with a Python base image
+FROM python:3.10-slim
+
+# Set working directory
+WORKDIR /app
+
+# Copy necessary files
+COPY . .
+
+# Install hatch to handle the build
+RUN pip install hatch
+
+# Clean dist directory before build
+RUN rm -rf dist/*
+
+# Use hatch to build the package and install it
+RUN hatch build && pip install dist/*.whl
+
+# Set environment variables required for the MCP server
+# These can be overridden at runtime with docker run --env
+ENV ELASTICSEARCH_HOST="https://localhost:9200"
+ENV ELASTICSEARCH_USERNAME="elastic"
+ENV ELASTICSEARCH_PASSWORD="test123"
+
+# Expose the port the server is running on (if applicable)
+EXPOSE 8000
+
+# Command to run the server
+ENTRYPOINT ["elasticsearch-mcp-server"]

{elasticsearch_mcp_server-1.0.0 → elasticsearch_mcp_server-2.0.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: elasticsearch-mcp-server
-Version: 1.0.0
-Summary: MCP Server for interacting with Elasticsearch
+Version: 2.0.0
+Summary: MCP Server for interacting with Elasticsearch and OpenSearch
 License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
@@ -205,17 +205,23 @@ License:                                  Apache License
            limitations under the License.
 License-File: LICENSE
 Requires-Python: >=3.10
+Requires-Dist: anthropic>=0.49.0
 Requires-Dist: elasticsearch>=8.0.0
 Requires-Dist: fastmcp>=0.4.0
 Requires-Dist: mcp>=1.0.0
+Requires-Dist: opensearch-py>=2.0.0
 Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: tomli-w>=1.2.0
+Requires-Dist: tomli>=2.2.1
 Description-Content-Type: text/markdown
 
-# Elasticsearch MCP Server
+# Elasticsearch/OpenSearch MCP Server
+
+[![smithery badge](https://smithery.ai/badge/elasticsearch-mcp-server)](https://smithery.ai/server/elasticsearch-mcp-server)
 
 ## Overview
 
-A Model Context Protocol (MCP) server implementation that provides Elasticsearch interaction. This server enables searching documents, analyzing indices, and managing cluster through a set of tools.
+A Model Context Protocol (MCP) server implementation that provides Elasticsearch and OpenSearch interaction. This server enables searching documents, analyzing indices, and managing cluster through a set of tools.
 
 <a href="https://glama.ai/mcp/servers/b3po3delex"><img width="380" height="200" src="https://glama.ai/mcp/servers/b3po3delex/badge" alt="Elasticsearch MCP Server" /></a>
 
@@ -227,41 +233,67 @@ https://github.com/user-attachments/assets/f7409e31-fac4-4321-9c94-b0ff2ea7ff15
 
 ### Index Operations
 
-- `list_indices`: List all indices in the Elasticsearch cluster.
-- `get_mapping`: Retrieve the mapping configuration for a specific index.
-- `get_settings`: Get the settings configuration for a specific index.
+- `list_indices`: List all indices.
+- `get_index`: Returns information (mappings, settings, aliases) about one or more indices.
+- `create_index`: Create a new index.
+- `delete_index`: Delete an index.
 
 ### Document Operations
 
-- `search_documents`: Search documents in an index using Elasticsearch Query DSL.
+- `search_documents`: Search for documents.
+- `index_document`: Creates or updates a document in the index.
+- `get_document`: Get a document by ID.
+- `delete_document`: Delete a document by ID.
+- `delete_by_query`: Deletes documents matching the provided query.
 
 ### Cluster Operations
 
-- `get_cluster_health`: Get health status of the cluster.
-- `get_cluster_stats`: Get statistical information about the cluster.
+- `get_cluster_health`: Returns basic information about the health of the cluster.
+- `get_cluster_stats`: Returns high-level overview of cluster statistics.
+
+### Alias Operations
+
+- `list_aliases`: List all aliases.
+- `get_alias`: Get alias information for a specific index.
+- `put_alias`: Create or update an alias for a specific index.
+- `delete_alias`: Delete an alias for a specific index.
 
+## Configure Environment Variables
 
-## Start Elasticsearch Cluster
+Copy the `.env.example` file to `.env` and update the values accordingly.
 
-Start the Elasticsearch cluster using Docker Compose:
+## Start Elasticsearch/OpenSearch Cluster
+
+Start the Elasticsearch/OpenSearch cluster using Docker Compose:
 
 ```bash
-docker-compose up -d
+# For Elasticsearch
+docker-compose -f docker-compose-elasticsearch.yml up -d
+
+# For OpenSearch
+docker-compose -f docker-compose-opensearch.yml up -d
 ```
 
-This will start a 3-node Elasticsearch cluster and Kibana. Default Elasticsearch username `elastic`, password `test123`.
+The default Elasticsearch username is `elastic` and password is `test123`. The default OpenSearch username is `admin` and password is `admin`.
 
-You can access Kibana from http://localhost:5601.
+You can access Kibana/OpenSearch Dashboards from http://localhost:5601.
 
 ## Usage with Claude Desktop
 
-Add the following configuration to Claude Desktop's config file `claude_desktop_config.json`.
+### Option 1: Installing via Smithery
 
-### Option 1: Using uvx (Recommended)
+To install Elasticsearch Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/elasticsearch-mcp-server):
 
-Using `uvx` will automatically install the package from PyPI, no need to clone the repository locally
+```bash
+npx -y @smithery/cli install elasticsearch-mcp-server --client claude
+```
+
+### Option 2: Using uvx
+
+Using `uvx` will automatically install the package from PyPI, no need to clone the repository locally. Add the following configuration to Claude Desktop's config file `claude_desktop_config.json`.
 
 ```json
+// For Elasticsearch
 {
   "mcpServers": {
     "elasticsearch-mcp-server": {
@@ -270,23 +302,41 @@ Using `uvx` will automatically install the package from PyPI, no need to clone t
         "elasticsearch-mcp-server"
       ],
       "env": {
-        "ELASTIC_HOST": "https://localhost:9200",
-        "ELASTIC_USERNAME": "elastic",
-        "ELASTIC_PASSWORD": "test123"
+        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_USERNAME": "elastic",
+        "ELASTICSEARCH_PASSWORD": "test123"
+      }
+    }
+  }
+}
+
+// For OpenSearch
+{
+  "mcpServers": {
+    "opensearch-mcp-server": {
+      "command": "uvx",
+      "args": [
+        "opensearch-mcp-server"
+      ],
+      "env": {
+        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_USERNAME": "admin",
+        "OPENSEARCH_PASSWORD": "admin"
       }
     }
   }
 }
 ```
 
-### Option 2: Using uv with local development
+### Option 3: Using uv with local development
 
-Using `uv` requires cloning the repository locally and specifying the path to the source code.
+Using `uv` requires cloning the repository locally and specifying the path to the source code. Add the following configuration to Claude Desktop's config file `claude_desktop_config.json`.
 
 ```json
+// For Elasticsearch
 {
   "mcpServers": {
-    "elasticsearch": {
+    "elasticsearch-mcp-server": {
       "command": "uv",
       "args": [
         "--directory",
@@ -295,9 +345,29 @@ Using `uv` requires cloning the repository locally and specifying the path to th
         "elasticsearch-mcp-server"
       ],
       "env": {
-        "ELASTIC_HOST": "https://localhost:9200",
-        "ELASTIC_USERNAME": "elastic",
-        "ELASTIC_PASSWORD": "test123"
+        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_USERNAME": "elastic",
+        "ELASTICSEARCH_PASSWORD": "test123"
+      }
+    }
+  }
+}
+
+// For OpenSearch
+{
+  "mcpServers": {
+    "opensearch-mcp-server": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "path/to/src/elasticsearch_mcp_server",
+        "run",
+        "opensearch-mcp-server"
+      ],
+      "env": {
+        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_USERNAME": "admin",
+        "OPENSEARCH_PASSWORD": "admin"
       }
     }
   }
@@ -309,11 +379,17 @@ Using `uv` requires cloning the repository locally and specifying the path to th
 
 Restart Claude Desktop to load the new MCP server.
 
-Now you can interact with your Elasticsearch cluster through Claude using natural language commands like:
+Now you can interact with your Elasticsearch/OpenSearch cluster through Claude using natural language commands like:
 - "List all indices in the cluster"
 - "How old is the student Bob?"
 - "Show me the cluster health status"
 
+## Usage with Anthropic MCP Client
+
+```python
+uv run mcp_client/client.py src/server.py
+```
+
 ## License
 
-This project is licensed under the Apache License Version 2.0 - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the Apache License Version 2.0 - see the [LICENSE](LICENSE) file for details.

elasticsearch_mcp_server-2.0.0/README.md

@@ -0,0 +1,178 @@
+# Elasticsearch/OpenSearch MCP Server
+
+[![smithery badge](https://smithery.ai/badge/elasticsearch-mcp-server)](https://smithery.ai/server/elasticsearch-mcp-server)
+
+## Overview
+
+A Model Context Protocol (MCP) server implementation that provides Elasticsearch and OpenSearch interaction. This server enables searching documents, analyzing indices, and managing cluster through a set of tools.
+
+<a href="https://glama.ai/mcp/servers/b3po3delex"><img width="380" height="200" src="https://glama.ai/mcp/servers/b3po3delex/badge" alt="Elasticsearch MCP Server" /></a>
+
+## Demo
+
+https://github.com/user-attachments/assets/f7409e31-fac4-4321-9c94-b0ff2ea7ff15
+
+## Features
+
+### Index Operations
+
+- `list_indices`: List all indices.
+- `get_index`: Returns information (mappings, settings, aliases) about one or more indices.
+- `create_index`: Create a new index.
+- `delete_index`: Delete an index.
+
+### Document Operations
+
+- `search_documents`: Search for documents.
+- `index_document`: Creates or updates a document in the index.
+- `get_document`: Get a document by ID.
+- `delete_document`: Delete a document by ID.
+- `delete_by_query`: Deletes documents matching the provided query.
+
+### Cluster Operations
+
+- `get_cluster_health`: Returns basic information about the health of the cluster.
+- `get_cluster_stats`: Returns high-level overview of cluster statistics.
+
+### Alias Operations
+
+- `list_aliases`: List all aliases.
+- `get_alias`: Get alias information for a specific index.
+- `put_alias`: Create or update an alias for a specific index.
+- `delete_alias`: Delete an alias for a specific index.
+
+## Configure Environment Variables
+
+Copy the `.env.example` file to `.env` and update the values accordingly.
+
+## Start Elasticsearch/OpenSearch Cluster
+
+Start the Elasticsearch/OpenSearch cluster using Docker Compose:
+
+```bash
+# For Elasticsearch
+docker-compose -f docker-compose-elasticsearch.yml up -d
+
+# For OpenSearch
+docker-compose -f docker-compose-opensearch.yml up -d
+```
+
+The default Elasticsearch username is `elastic` and password is `test123`. The default OpenSearch username is `admin` and password is `admin`.
+
+You can access Kibana/OpenSearch Dashboards from http://localhost:5601.
+
+## Usage with Claude Desktop
+
+### Option 1: Installing via Smithery
+
+To install Elasticsearch Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/elasticsearch-mcp-server):
+
+```bash
+npx -y @smithery/cli install elasticsearch-mcp-server --client claude
+```
+
+### Option 2: Using uvx
+
+Using `uvx` will automatically install the package from PyPI, no need to clone the repository locally. Add the following configuration to Claude Desktop's config file `claude_desktop_config.json`.
+
+```json
+// For Elasticsearch
+{
+  "mcpServers": {
+    "elasticsearch-mcp-server": {
+      "command": "uvx",
+      "args": [
+        "elasticsearch-mcp-server"
+      ],
+      "env": {
+        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_USERNAME": "elastic",
+        "ELASTICSEARCH_PASSWORD": "test123"
+      }
+    }
+  }
+}
+
+// For OpenSearch
+{
+  "mcpServers": {
+    "opensearch-mcp-server": {
+      "command": "uvx",
+      "args": [
+        "opensearch-mcp-server"
+      ],
+      "env": {
+        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_USERNAME": "admin",
+        "OPENSEARCH_PASSWORD": "admin"
+      }
+    }
+  }
+}
+```
+
+### Option 3: Using uv with local development
+
+Using `uv` requires cloning the repository locally and specifying the path to the source code. Add the following configuration to Claude Desktop's config file `claude_desktop_config.json`.
+
+```json
+// For Elasticsearch
+{
+  "mcpServers": {
+    "elasticsearch-mcp-server": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "path/to/src/elasticsearch_mcp_server",
+        "run",
+        "elasticsearch-mcp-server"
+      ],
+      "env": {
+        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_USERNAME": "elastic",
+        "ELASTICSEARCH_PASSWORD": "test123"
+      }
+    }
+  }
+}
+
+// For OpenSearch
+{
+  "mcpServers": {
+    "opensearch-mcp-server": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "path/to/src/elasticsearch_mcp_server",
+        "run",
+        "opensearch-mcp-server"
+      ],
+      "env": {
+        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_USERNAME": "admin",
+        "OPENSEARCH_PASSWORD": "admin"
+      }
+    }
+  }
+}
+```
+
+- On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
+
+Restart Claude Desktop to load the new MCP server.
+
+Now you can interact with your Elasticsearch/OpenSearch cluster through Claude using natural language commands like:
+- "List all indices in the cluster"
+- "How old is the student Bob?"
+- "Show me the cluster health status"
+
+## Usage with Anthropic MCP Client
+
+```python
+uv run mcp_client/client.py src/server.py
+```
+
+## License
+
+This project is licensed under the Apache License Version 2.0 - see the [LICENSE](LICENSE) file for details.

{elasticsearch_mcp_server-1.0.0 → elasticsearch_mcp_server-2.0.0}/cliff.toml

@@ -97,4 +97,4 @@ git_path = "git"
 # whether to use relaxed or strict semver parsing
 relaxed_semver = true
 # only show the changes for the current version
-tag_range = true
+tag_range = true

elasticsearch_mcp_server-1.0.0/docker-compose.yml → elasticsearch_mcp_server-2.0.0/docker-compose-elasticsearch.yml

@@ -6,8 +6,8 @@ services:
     user: "0"
     command: >
       bash -c '
-        if [ x${ELASTIC_PASSWORD} == x ]; then
-          echo "Set the ELASTIC_PASSWORD environment variable in the .env file";
+        if [ x${ELASTICSEARCH_PASSWORD} == x ]; then
+          echo "Set the ELASTICSEARCH_PASSWORD environment variable in the .env file";
           exit 1;
         fi;
         if [ ! -f config/certs/ca.zip ]; then
@@ -48,7 +48,7 @@ services:
         echo "Waiting for Elasticsearch availability";
         until curl -s --cacert config/certs/ca/ca.crt https://es01:9200 | grep -q "missing authentication credentials"; do sleep 30; done;
         echo "Setting kibana_system password";
-        until curl -s -X POST --cacert config/certs/ca/ca.crt -u "elastic:${ELASTIC_PASSWORD}" -H "Content-Type: application/json" https://es01:9200/_security/user/kibana_system/_password -d "{\"password\":\"kibana123\"}" | grep -q "^{}"; do sleep 10; done;
+        until curl -s -X POST --cacert config/certs/ca/ca.crt -u "elastic:${ELASTICSEARCH_PASSWORD}" -H "Content-Type: application/json" https://es01:9200/_security/user/kibana_system/_password -d "{\"password\":\"kibana123\"}" | grep -q "^{}"; do sleep 10; done;
         echo "All done!";
       '
     healthcheck:
@@ -72,7 +72,7 @@ services:
       - cluster.name=es-mcp-cluster
       - cluster.initial_master_nodes=es01,es02,es03
       - discovery.seed_hosts=es02,es03
-      - ELASTIC_PASSWORD=${ELASTIC_PASSWORD}
+      - ELASTIC_PASSWORD=${ELASTICSEARCH_PASSWORD}
       - bootstrap.memory_lock=true
       - xpack.security.enabled=true
       - xpack.security.http.ssl.enabled=true

elasticsearch_mcp_server-2.0.0/docker-compose-opensearch.yml

@@ -0,0 +1,71 @@
+services:
+  opensearch-node1: # This is also the hostname of the container within the Docker network (i.e. https://opensearch-node1/)
+    image: opensearchproject/opensearch:2.11.0
+    container_name: opensearch-node1
+    environment:
+      - cluster.name=opensearch-cluster # Name the cluster
+      - node.name=opensearch-node1 # Name the node that will run in this container
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2 # Nodes to look for when discovering the cluster
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2 # Nodes eligibile to serve as cluster manager
+      - bootstrap.memory_lock=true # Disable JVM heap memory swapping
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" # Set min and max JVM heap sizes to at least 50% of system RAM
+      - cluster.routing.allocation.disk.watermark.low=2gb
+      - cluster.routing.allocation.disk.watermark.high=1gb
+      - cluster.routing.allocation.disk.watermark.flood_stage=512mb
+    ulimits:
+      memlock:
+        soft: -1 # Set memlock to unlimited (no soft or hard limit)
+        hard: -1
+      nofile:
+        soft: 65536 # Maximum number of open files for the opensearch user - set to at least 65536
+        hard: 65536
+    volumes:
+      - opensearch-data1:/usr/share/opensearch/data # Creates volume called opensearch-data1 and mounts it to the container
+    ports:
+      - 9200:9200 # REST API
+      - 9600:9600 # Performance Analyzer
+    networks:
+      - opensearch-net # All of the containers will join the same Docker bridge network
+  opensearch-node2:
+    image: opensearchproject/opensearch:2.11.0 # This should be the same image used for opensearch-node1 to avoid issues
+    container_name: opensearch-node2
+    environment:
+      - cluster.name=opensearch-cluster
+      - node.name=opensearch-node2
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
+      - bootstrap.memory_lock=true
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
+      - cluster.routing.allocation.disk.watermark.low=2gb
+      - cluster.routing.allocation.disk.watermark.high=1gb
+      - cluster.routing.allocation.disk.watermark.flood_stage=512mb
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    volumes:
+      - opensearch-data2:/usr/share/opensearch/data
+    networks:
+      - opensearch-net
+  opensearch-dashboards:
+    image: opensearchproject/opensearch-dashboards:2.11.0 # Make sure the version of opensearch-dashboards matches the version of opensearch installed on other nodes
+    container_name: opensearch-dashboards
+    ports:
+      - 5601:5601 # Map host port 5601 to container port 5601
+    expose:
+      - "5601" # Expose port 5601 for web access to OpenSearch Dashboards
+    environment:
+      OPENSEARCH_HOSTS: '["https://opensearch-node1:9200","https://opensearch-node2:9200"]' # Define the OpenSearch nodes that OpenSearch Dashboards will query
+    networks:
+      - opensearch-net
+
+volumes:
+  opensearch-data1:
+  opensearch-data2:
+
+networks:
+  opensearch-net:
+  

elasticsearch_mcp_server-2.0.0/mcp_client/.gitignore

@@ -0,0 +1 @@
+.env