opensearch-mcp-server 2.0.9__py3-none-any.whl → 2.0.11__py3-none-any.whl

{opensearch_mcp_server-2.0.9.dist-info → opensearch_mcp_server-2.0.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensearch-mcp-server
-Version: 2.0.9
+Version: 2.0.11
 Summary: MCP Server for interacting with Elasticsearch and OpenSearch
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -218,10 +218,10 @@ Description-Content-Type: text/markdown
 
 # Elasticsearch/OpenSearch MCP Server
 
-[![smithery badge](https://smithery.ai/badge/elasticsearch-mcp-server)](https://smithery.ai/server/elasticsearch-mcp-server)
-
 [![MseeP.ai Security Assessment Badge](https://mseep.net/pr/cr7258-elasticsearch-mcp-server-badge.png)](https://mseep.ai/app/cr7258-elasticsearch-mcp-server)
 
+[![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/cr7258/elasticsearch-mcp-server)](https://archestra.ai/mcp-catalog/cr7258__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.
@@ -267,7 +267,20 @@ https://github.com/user-attachments/assets/f7409e31-fac4-4321-9c94-b0ff2ea7ff15
 
 ## Configure Environment Variables
 
-Copy the `.env.example` file to `.env` and update the values accordingly.
+The MCP server supports the following environment variables for authentication:
+
+### Basic Authentication (Username/Password)
+- `ELASTICSEARCH_USERNAME`: Username for basic authentication
+- `ELASTICSEARCH_PASSWORD`: Password for basic authentication
+- `OPENSEARCH_USERNAME`: Username for OpenSearch basic authentication
+- `OPENSEARCH_PASSWORD`: Password for OpenSearch basic authentication
+
+### API Key Authentication (Elasticsearch only) - Recommended
+- `ELASTICSEARCH_API_KEY`: API key for [Elasticsearch](https://www.elastic.co/docs/deploy-manage/api-keys/elasticsearch-api-keys) or [Elastic Cloud](https://www.elastic.co/docs/deploy-manage/api-keys/elastic-cloud-api-keys) Authentication.
+
+### Other Configuration
+- `ELASTICSEARCH_HOSTS` / `OPENSEARCH_HOSTS`: Comma-separated list of hosts (default: `https://localhost:9200`)
+- `ELASTICSEARCH_VERIFY_CERTS` / `OPENSEARCH_VERIFY_CERTS`: Whether to verify SSL certificates (default: `false`)
 
 ## Start Elasticsearch/OpenSearch Cluster
 
@@ -292,7 +305,7 @@ You can access Kibana/OpenSearch Dashboards from http://localhost:5601.
 Using `uvx` will automatically install the package from PyPI, no need to clone the repository locally. Add the following configuration to 's config file `claude_desktop_config.json`.
 
 ```json
-// For Elasticsearch
+// For Elasticsearch with username/password
 {
   "mcpServers": {
     "elasticsearch-mcp-server": {
@@ -309,6 +322,22 @@ Using `uvx` will automatically install the package from PyPI, no need to clone t
   }
 }
 
+// For Elasticsearch with API key
+{
+  "mcpServers": {
+    "elasticsearch-mcp-server": {
+      "command": "uvx",
+      "args": [
+        "elasticsearch-mcp-server"
+      ],
+      "env": {
+        "ELASTICSEARCH_HOSTS": "https://localhost:9200",
+        "ELASTICSEARCH_API_KEY": "<YOUR_ELASTICSEARCH_API_KEY>"
+      }
+    }
+  }
+}
+
 // For OpenSearch
 {
   "mcpServers": {
@@ -332,7 +361,7 @@ Using `uvx` will automatically install the package from PyPI, no need to clone t
 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
+// For Elasticsearch with username/password
 {
   "mcpServers": {
     "elasticsearch-mcp-server": {
@@ -352,6 +381,25 @@ Using `uv` requires cloning the repository locally and specifying the path to th
   }
 }
 
+// For Elasticsearch with API key
+{
+  "mcpServers": {
+    "elasticsearch-mcp-server": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "path/to/src/elasticsearch_mcp_server",
+        "run",
+        "elasticsearch-mcp-server"
+      ],
+      "env": {
+        "ELASTICSEARCH_HOSTS": "https://localhost:9200",
+        "ELASTICSEARCH_API_KEY": "<YOUR_ELASTICSEARCH_API_KEY>"
+      }
+    }
+  }
+}
+
 // For OpenSearch
 {
   "mcpServers": {
@@ -378,11 +426,15 @@ Using `uv` requires cloning the repository locally and specifying the path to th
 ### Option 1: Using uvx
 
 ```bash
-# export environment variables
+# export environment variables (with username/password)
 export ELASTICSEARCH_HOSTS="https://localhost:9200"
 export ELASTICSEARCH_USERNAME="elastic"
 export ELASTICSEARCH_PASSWORD="test123"
 
+# OR export environment variables (with API key)
+export ELASTICSEARCH_HOSTS="https://localhost:9200"
+export ELASTICSEARCH_API_KEY="<YOUR_ELASTICSEARCH_API_KEY>"
+
 # By default, the SSE MCP server will serve on http://127.0.0.1:8000/sse
 uvx elasticsearch-mcp-server --transport sse
 
@@ -405,11 +457,15 @@ uv run src/server.py elasticsearch-mcp-server --transport sse --host 0.0.0.0 --p
 ### Option 1: Using uvx
 
 ```bash
-# export environment variables
+# export environment variables (with username/password)
 export ELASTICSEARCH_HOSTS="https://localhost:9200"
 export ELASTICSEARCH_USERNAME="elastic"
 export ELASTICSEARCH_PASSWORD="test123"
 
+# OR export environment variables (with API key)
+export ELASTICSEARCH_HOSTS="https://localhost:9200"
+export ELASTICSEARCH_API_KEY="<YOUR_ELASTICSEARCH_API_KEY>"
+
 # By default, the Streamable HTTP MCP server will serve on http://127.0.0.1:8000/mcp
 uvx elasticsearch-mcp-server --transport streamable-http
 
@@ -427,6 +483,21 @@ uv run src/server.py elasticsearch-mcp-server --transport streamable-http
 uv run src/server.py elasticsearch-mcp-server --transport streamable-http --host 0.0.0.0 --port 8000 --path /mcp
 ```
 
+## Compatibility
+
+The MCP server is compatible with Elasticsearch 7.x, 8.x, and 9.x. By default, it uses the Elasticsearch 8.x client (without a suffix). To use the Elasticsearch 7.x client, run the `elasticsearch-mcp-server-es7` variant. For Elasticsearch 9.x, use `elasticsearch-mcp-server-es9`. For example:
+
+```bash
+uvx elasticsearch-mcp-server-es7
+```
+
+| MCP Server | Elasticsearch |
+| --- | --- |
+| elasticsearch-mcp-server-es7 | Elasticsearch 7.x |
+| elasticsearch-mcp-server | Elasticsearch 8.x |
+| elasticsearch-mcp-server-es9 | Elasticsearch 9.x |
+| opensearch-mcp-server | OpenSearch 1.x, 2.x, 3.x |
+
 ## License
 
 This project is licensed under the Apache License Version 2.0 - see the [LICENSE](LICENSE) file for details.

{opensearch_mcp_server-2.0.9.dist-info → opensearch_mcp_server-2.0.11.dist-info}/RECORD

@@ -1,8 +1,8 @@
 src/__init__.py,sha256=aNKcThftSLh9IjOTA-UUpoRzIm4R0WwXKGAzykwecmU,211
 src/server.py,sha256=BfMAgXTFV9C4waCWRro8Sfl6yXEXr2vJ7YoGY7HhMPY,5072
-src/version.py,sha256=pZib55qStLeBfZabni1F1OCNxdT02xP-5e34LjIBswQ,22
-src/clients/__init__.py,sha256=3UezAt9422S-7BvMiCo2Y9pmATVutorwsIQXP_g_CkA,1221
-src/clients/base.py,sha256=dKO18Wcq4gBc3j5Q1KbQ63heIir7jcX2Fl58uG7abyE,4674
+src/version.py,sha256=T-q0gGRSS4Se3uygy0WDtGhPp5plXECGZSjUouo_yUU,23
+src/clients/__init__.py,sha256=MUKeCxvAFzzVfQr4x1seB7cRVLtWAk7pb1-5tLG0T8g,1299
+src/clients/base.py,sha256=tMNdKRsAG1dPHj7famwPvCXCONuT9jML-7FmWV9vXbs,5348
 src/clients/exceptions.py,sha256=NYF3KVw-9aAgCViin5OuBI6miMEPS5QsdHx6bcis1wc,2493
 src/clients/common/__init__.py,sha256=VgvgxFpESn2wAuJmH0XM_Ej2izI7dxK7QJe9wG4fmW0,211
 src/clients/common/alias.py,sha256=rB53TSld5x2vZyDNAwyEdnh1KWUXMSD7h5fSv_ubR2Q,759
@@ -18,8 +18,8 @@ src/tools/document.py,sha256=XZTVuk4di9VEwWMZN7jyDVnzoOiXkb4FBrXF44sVXTs,2052
 src/tools/general.py,sha256=whj1spjIb8SS75h843X6c3RTsrZcSm-66KVLlY7OEh0,817
 src/tools/index.py,sha256=7KNPtElTFelkjRSvdMqPBx9nx_9Uk01OnTMeVo7YeCs,1345
 src/tools/register.py,sha256=wrG2P6-YPW77bTg1j_ELp8omWRYsJjFeOHUy_unHe6Y,1344
-opensearch_mcp_server-2.0.9.dist-info/METADATA,sha256=bin99eLiAa5zNKjqcBjokOclRhJj9VMVjX7YZPrrqXA,19863
-opensearch_mcp_server-2.0.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-opensearch_mcp_server-2.0.9.dist-info/entry_points.txt,sha256=ImfJnUwMpQUBmu-1MeBG_P0dwamfXKQh82mBKW7tWNY,138
-opensearch_mcp_server-2.0.9.dist-info/licenses/LICENSE,sha256=DBsjuP5FR51d9kaUdXlVBuBv3cQ_I_adq9gefYQ9FcY,11339
-opensearch_mcp_server-2.0.9.dist-info/RECORD,,
+opensearch_mcp_server-2.0.11.dist-info/METADATA,sha256=A_35ajQsEfqCYqo5hBp2jYX757DlbYUj4N_CO4utE_s,22552
+opensearch_mcp_server-2.0.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+opensearch_mcp_server-2.0.11.dist-info/entry_points.txt,sha256=ImfJnUwMpQUBmu-1MeBG_P0dwamfXKQh82mBKW7tWNY,138
+opensearch_mcp_server-2.0.11.dist-info/licenses/LICENSE,sha256=DBsjuP5FR51d9kaUdXlVBuBv3cQ_I_adq9gefYQ9FcY,11339
+opensearch_mcp_server-2.0.11.dist-info/RECORD,,

src/clients/__init__.py

@@ -24,12 +24,14 @@ def create_search_client(engine_type: str) -> SearchClient:
     hosts = [host.strip() for host in hosts_str.split(",")]
     username = os.environ.get(f"{prefix}_USERNAME")
     password = os.environ.get(f"{prefix}_PASSWORD")
+    api_key = os.environ.get(f"{prefix}_API_KEY")
     verify_certs = os.environ.get(f"{prefix}_VERIFY_CERTS", "false").lower() == "true"
     
     config = {
         "hosts": hosts,
         "username": username,
         "password": password,
+        "api_key": api_key,
         "verify_certs": verify_certs
     }
     

src/clients/base.py

@@ -24,6 +24,7 @@ class SearchClientBase(ABC):
         hosts = config.get("hosts")
         username = config.get("username")
         password = config.get("password")
+        api_key = config.get("api_key")
         verify_certs = config.get("verify_certs", False)
         
         # Disable insecure request warnings if verify_certs is False
@@ -39,8 +40,8 @@ class SearchClientBase(ABC):
         
         # Initialize client based on engine type
         if engine_type == "elasticsearch":
-            # Get auth parameters based on elasticsearch package version
-            auth_params = self._get_elasticsearch_auth_params(username, password)
+            # Get auth parameters based on elasticsearch package version and authentication method
+            auth_params = self._get_elasticsearch_auth_params(username, password, api_key)
             
             self.client = Elasticsearch(
                 hosts=hosts,
@@ -64,53 +65,67 @@ class SearchClientBase(ABC):
             base_url=base_url,
             username=username,
             password=password,
+            api_key=api_key,
             verify_certs=verify_certs,
         )
 
-    def _get_elasticsearch_auth_params(self, username: Optional[str], password: Optional[str]) -> Dict:
+    def _get_elasticsearch_auth_params(self, username: Optional[str], password: Optional[str], api_key: Optional[str]) -> Dict:
         """
         Get authentication parameters for Elasticsearch client based on package version.
         
         Args:
             username: Username for authentication
             password: Password for authentication
+            api_key: API key for authentication
             
         Returns:
             Dictionary with appropriate auth parameters for the ES version
         """
+        # API key takes precedence over username/password
+        if api_key:
+            return {"api_key": api_key}
+            
         if not username or not password:
             return {}
             
         # Check Elasticsearch package version to determine auth parameter name
         try:
             from elasticsearch import __version__ as es_version
-            major_version = int(es_version.split('.')[0])
-            
+            major_version = es_version[0]    
             if major_version >= 8:
                 # ES 8+ uses basic_auth
                 return {"basic_auth": (username, password)}
             else:
                 # ES 7 and below use http_auth
                 return {"http_auth": (username, password)}
-        except (ImportError, ValueError, AttributeError):
+        except Exception as e:
+            self.logger.error(f"Failed to detect Elasticsearch version: {e}")
             # If we can't detect version, try basic_auth first (ES 8+ default)
             return {"basic_auth": (username, password)}
 
 class GeneralRestClient:
-    def __init__(self, base_url: Optional[str], username: Optional[str], password: Optional[str], verify_certs: bool):
+    def __init__(self, base_url: Optional[str], username: Optional[str], password: Optional[str], api_key: Optional[str], verify_certs: bool):
         self.base_url = base_url.rstrip("/") if base_url else ""
         self.auth = (username, password) if username and password else None
+        self.api_key = api_key
         self.verify_certs = verify_certs
 
     def request(self, method, path, params=None, body=None):
         url = f"{self.base_url}/{path.lstrip('/')}"
+        headers = {}
+        
+        # Add API key to Authorization header if provided
+        if self.api_key:
+            headers["Authorization"] = f"ApiKey {self.api_key}"
+        
         with httpx.Client(verify=self.verify_certs) as client:
             resp = client.request(
                 method=method.upper(),
                 url=url,
                 params=params,
                 json=body,
-                auth=self.auth
+                auth=self.auth if not self.api_key else None,  # Use basic auth only if no API key
+                headers=headers
             )
             resp.raise_for_status()
             ct = resp.headers.get("content-type", "")

src/version.py

@@ -1 +1 @@
-__version__ = "2.0.9"
+__version__ = "2.0.11"