elasticsearch-mcp-server 2.0.17__py3-none-any.whl

elasticsearch_mcp_server-2.0.17.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2025] [cr7258]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

src/__init__.py

@@ -0,0 +1,6 @@
+"""
+Search MCP Server package.
+"""
+from src.server import elasticsearch_mcp_server, opensearch_mcp_server, run_search_server
+
+__all__ = ['elasticsearch_mcp_server', 'opensearch_mcp_server', 'run_search_server']

src/clients/__init__.py

@@ -0,0 +1,44 @@
+import os
+
+from dotenv import load_dotenv
+
+from src.clients.common.client import SearchClient
+from src.clients.exceptions import handle_search_exceptions
+
+def create_search_client(engine_type: str) -> SearchClient:
+    """
+    Create a search client for the specified engine type.
+    
+    Args:
+        engine_type: Type of search engine to use ("elasticsearch" or "opensearch")
+        
+    Returns:
+        A search client instance
+    """
+    # Load configuration from environment variables
+    load_dotenv()
+    
+    # Get configuration from environment variables
+    prefix = engine_type.upper()
+    hosts_str = os.environ.get(f"{prefix}_HOSTS", "https://localhost:9200")
+    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
+    }
+    
+    return SearchClient(config, engine_type)
+
+__all__ = [
+    'create_search_client',
+    'handle_search_exceptions',
+    'SearchClient',
+]

src/clients/base.py

@@ -0,0 +1,137 @@
+from abc import ABC
+import logging
+import warnings
+from typing import Dict, Optional
+
+from elasticsearch import Elasticsearch
+import httpx
+from opensearchpy import OpenSearch
+
+class SearchClientBase(ABC):
+    def __init__(self, config: Dict, engine_type: str):
+        """
+        Initialize the search client.
+        
+        Args:
+            config: Configuration dictionary with connection parameters
+            engine_type: Type of search engine to use ("elasticsearch" or "opensearch")
+        """
+        self.logger = logging.getLogger()
+        self.config = config
+        self.engine_type = engine_type
+        
+        # Extract common configuration
+        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
+        if not verify_certs:
+            warnings.filterwarnings("ignore", message=".*verify_certs=False is insecure.*")
+            warnings.filterwarnings("ignore", message=".*Unverified HTTPS request is being made to host.*")
+            
+            try:
+                import urllib3
+                urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+            except ImportError:
+                pass
+        
+        # Initialize client based on engine type
+        if engine_type == "elasticsearch":
+            # 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,
+                verify_certs=verify_certs,
+                **auth_params
+            )
+            self.logger.info(f"Elasticsearch client initialized with hosts: {hosts}")
+        elif engine_type == "opensearch":
+            self.client = OpenSearch(
+                hosts=hosts,
+                http_auth=(username, password) if username and password else None,
+                verify_certs=verify_certs
+            )
+            self.logger.info(f"OpenSearch client initialized with hosts: {hosts}")
+        else:
+            raise ValueError(f"Unsupported engine type: {engine_type}")
+
+        # General REST client
+        base_url = hosts[0] if isinstance(hosts, list) else hosts
+        self.general_client = GeneralRestClient(
+            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], 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
+            # Convert version tuple to string format
+            version_str = '.'.join(map(str, es_version))
+            self.logger.info(f"Elasticsearch client version: {version_str}")
+            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 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], 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 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", "")
+            if ct.startswith("application/json"):
+                return resp.json()
+            return resp.text

src/clients/common/__init__.py

@@ -0,0 +1,6 @@
+from .index import IndexClient
+from .document import DocumentClient
+from .cluster import ClusterClient
+from .alias import AliasClient
+
+__all__ = ['IndexClient', 'DocumentClient', 'ClusterClient', 'AliasClient']

src/clients/common/alias.py

@@ -0,0 +1,20 @@
+from typing import Dict
+
+from src.clients.base import SearchClientBase
+
+class AliasClient(SearchClientBase):
+    def list_aliases(self) -> Dict:
+        """Get all aliases."""
+        return self.client.cat.aliases()
+    
+    def get_alias(self, index: str) -> Dict:
+        """Get aliases for the specified index."""
+        return self.client.indices.get_alias(index=index)
+
+    def put_alias(self, index: str, name: str, body: Dict) -> Dict:
+        """Creates or updates an alias."""
+        return self.client.indices.put_alias(index=index, name=name, body=body)
+    
+    def delete_alias(self, index: str, name: str) -> Dict:
+        """Delete an alias for the specified index."""
+        return self.client.indices.delete_alias(index=index, name=name)

src/clients/common/client.py

@@ -0,0 +1,27 @@
+from typing import Dict
+
+from src.clients.common.alias import AliasClient
+from src.clients.common.cluster import ClusterClient
+from src.clients.common.data_stream import DataStreamClient
+from src.clients.common.document import DocumentClient
+from src.clients.common.general import GeneralClient
+from src.clients.common.index import IndexClient
+
+class SearchClient(IndexClient, DocumentClient, ClusterClient, AliasClient, DataStreamClient, GeneralClient):
+    """
+    Unified search client that combines all search functionality.
+    
+    This class uses multiple inheritance to combine all specialized client implementations
+    (index, document, cluster, alias) into a single unified client.
+    """
+    
+    def __init__(self, config: Dict, engine_type: str):
+        """
+        Initialize the search client.
+        
+        Args:
+            config: Configuration dictionary with connection parameters
+            engine_type: Type of search engine to use ("elasticsearch" or "opensearch")
+        """
+        super().__init__(config, engine_type)
+        self.logger.info(f"Initialized the {engine_type} client")

src/clients/common/cluster.py

@@ -0,0 +1,12 @@
+from typing import Dict
+
+from src.clients.base import SearchClientBase
+
+class ClusterClient(SearchClientBase):
+    def get_cluster_health(self) -> Dict:
+        """Get cluster health information from OpenSearch."""
+        return self.client.cluster.health()
+    
+    def get_cluster_stats(self) -> Dict:
+        """Get cluster statistics from OpenSearch."""
+        return self.client.cluster.stats()

src/clients/common/data_stream.py

@@ -0,0 +1,18 @@
+from typing import Dict, Optional
+from src.clients.base import SearchClientBase
+
+class DataStreamClient(SearchClientBase):  
+    def create_data_stream(self, name: str) -> Dict:
+        """Create a new data stream."""
+        return self.client.indices.create_data_stream(name=name)
+    
+    def get_data_stream(self, name: Optional[str] = None) -> Dict:
+        """Get information about one or more data streams."""
+        if name:
+            return self.client.indices.get_data_stream(name=name)
+        else:
+            return self.client.indices.get_data_stream()
+    
+    def delete_data_stream(self, name: str) -> Dict:
+        """Delete one or more data streams."""
+        return self.client.indices.delete_data_stream(name=name)

src/clients/common/document.py

@@ -0,0 +1,37 @@
+from typing import Dict, Optional
+
+from src.clients.base import SearchClientBase
+
+class DocumentClient(SearchClientBase):
+    def search_documents(self, index: str, body: Dict) -> Dict:
+        """Search for documents in the index."""
+        return self.client.search(index=index, body=body)
+    
+    def index_document(self, index: str, document: Dict, id: Optional[str] = None) -> Dict:
+        """Creates a new document in the index."""
+        # Handle parameter name differences between Elasticsearch and OpenSearch
+        if self.engine_type == "elasticsearch":
+            # For Elasticsearch: index(index, document, id=None, ...)
+            if id is not None:
+                return self.client.index(index=index, document=document, id=id)
+            else:
+                return self.client.index(index=index, document=document)
+        else:
+            # For OpenSearch: index(index, body, id=None, ...)
+            if id is not None:
+                return self.client.index(index=index, body=document, id=id)
+            else:
+                return self.client.index(index=index, body=document)
+    
+    def get_document(self, index: str, id: str) -> Dict:
+        """Get a document by ID."""
+        return self.client.get(index=index, id=id)
+    
+    def delete_document(self, index: str, id: str) -> Dict:
+        """Removes a document from the index."""
+        return self.client.delete(index=index, id=id)
+
+    def delete_by_query(self, index: str, body: Dict) -> Dict:
+        """Deletes documents matching the provided query."""
+        return self.client.delete_by_query(index=index, body=body)
+

src/clients/common/general.py

@@ -0,0 +1,10 @@
+from typing import Dict, Optional
+
+from src.clients.base import SearchClientBase
+
+class GeneralClient(SearchClientBase):
+    def general_api_request(self, method: str, path: str, params: Optional[Dict] = None, body: Optional[Dict] = None):
+        """Perform a general HTTP API request.
+           Use this tool for any Elasticsearch/OpenSearch API that does not have a dedicated tool.
+        """
+        return self.general_client.request(method, path, params, body)

src/clients/common/index.py

@@ -0,0 +1,20 @@
+from typing import Dict, Optional
+
+from src.clients.base import SearchClientBase
+
+class IndexClient(SearchClientBase):
+    def list_indices(self) -> Dict:
+        """List all indices."""
+        return self.client.cat.indices()
+    
+    def get_index(self, index: str) -> Dict:
+        """Returns information (mappings, settings, aliases) about one or more indices."""
+        return self.client.indices.get(index=index)
+    
+    def create_index(self, index: str, body: Optional[Dict] = None) -> Dict:
+        """Creates an index with optional settings and mappings."""
+        return self.client.indices.create(index=index, body=body)
+    
+    def delete_index(self, index: str) -> Dict:
+        """Delete an index."""
+        return self.client.indices.delete(index=index)

src/clients/exceptions.py

@@ -0,0 +1,69 @@
+import functools
+import logging
+from typing import TypeVar, Callable
+
+from fastmcp import FastMCP
+from mcp.types import TextContent
+
+T = TypeVar('T')
+
+def handle_search_exceptions(func: Callable[..., T]) -> Callable[..., list[TextContent]]:
+    """
+    Decorator to handle exceptions in search client operations.
+    
+    Args:
+        func: The function to decorate
+        
+    Returns:
+        Decorated function that handles exceptions
+    """
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        logger = logging.getLogger()   
+        try:
+            return func(*args, **kwargs)
+        except Exception as e:
+            logger.error(f"Unexpected error in {func.__name__}: {e}")
+            return [TextContent(type="text", text=f"Unexpected error in {func.__name__}: {str(e)}")]
+    
+    return wrapper
+
+def with_exception_handling(tool_instance: object, mcp: FastMCP) -> None:
+    """
+    Register tools from a tool instance with automatic exception handling applied to all tools.
+    
+    This function temporarily replaces mcp.tool with a wrapped version that automatically
+    applies the handle_search_exceptions decorator to all registered tool methods.
+    
+    Args:
+        tool_instance: The tool instance that has a register_tools method
+        mcp: The FastMCP instance used for tool registration
+    """
+    # Save the original tool method
+    original_tool = mcp.tool
+
+    @functools.wraps(original_tool)
+    def wrapped_tool(*args, **kwargs):
+        # Get the original decorator
+        decorator = original_tool(*args, **kwargs)
+
+        # Return a new decorator that applies both the exception handler and original decorator
+        def combined_decorator(func):
+            # First apply the exception handling decorator
+            wrapped_func = handle_search_exceptions(func)
+            # Then apply the original mcp.tool decorator
+            return decorator(wrapped_func)
+
+        return combined_decorator
+
+    try:
+        # Temporarily replace mcp.tool with our wrapped version
+        mcp.tool = wrapped_tool
+
+        # Call the registration method on the tool instance
+        tool_instance.register_tools(mcp)
+    finally:
+        # Restore the original mcp.tool to avoid affecting other code that might use mcp.tool
+        # This ensures that our modification is isolated to just this tool registration
+        # and prevents multiple nested decorators if register_all_tools is called multiple times
+        mcp.tool = original_tool