opensearch-mcp-server 2.0.2__py3-none-any.whl → 2.0.3__py3-none-any.whl

{opensearch_mcp_server-2.0.2.dist-info → opensearch_mcp_server-2.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensearch-mcp-server
-Version: 2.0.2
+Version: 2.0.3
 Summary: MCP Server for interacting with Elasticsearch and OpenSearch
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -211,6 +211,7 @@ Requires-Dist: fastmcp==0.4.1
 Requires-Dist: mcp==1.6.0
 Requires-Dist: opensearch-py==2.8.0
 Requires-Dist: python-dotenv==1.1.0
+Requires-Dist: toml==0.10.2
 Requires-Dist: tomli-w==1.2.0
 Requires-Dist: tomli==2.2.1
 Description-Content-Type: text/markdown
@@ -231,6 +232,10 @@ https://github.com/user-attachments/assets/f7409e31-fac4-4321-9c94-b0ff2ea7ff15
 
 ## Features
 
+### General Operations
+
+- `general_api_request`: Perform a general HTTP API request. Use this tool for any Elasticsearch/OpenSearch API that does not have a dedicated tool.
+
 ### Index Operations
 
 - `list_indices`: List all indices.

{opensearch_mcp_server-2.0.2.dist-info → opensearch_mcp_server-2.0.3.dist-info}/RECORD

@@ -1,22 +1,24 @@
 src/__init__.py,sha256=aNKcThftSLh9IjOTA-UUpoRzIm4R0WwXKGAzykwecmU,211
-src/server.py,sha256=BtNr3oKiRK1rbnocFIKzwpukY87_AylzKh_ffwP6Zr8,2153
+src/server.py,sha256=2EyBWtdAIct-L589FXhxTfQswsgo9nusC9ZORVfwXWU,2330
 src/clients/__init__.py,sha256=3UezAt9422S-7BvMiCo2Y9pmATVutorwsIQXP_g_CkA,1221
-src/clients/base.py,sha256=vTe4I62ruO2bEeSAag-2B5fJOWJDXllKbo8qA0h4VkM,2160
+src/clients/base.py,sha256=MBAGepXyHPtdbtHhxFB8CamZ2ApWCBuOi_6-ey-MqX8,3298
 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
-src/clients/common/client.py,sha256=GD-V97Dj8c2XGUYt58vqCggkk-k8WJePPgngBDWO5aM,973
+src/clients/common/client.py,sha256=khRO3osowTvoXnPscefUSuBYMrhOao2urOnRwqiUMbI,1041
 src/clients/common/cluster.py,sha256=pd5BVpqqDU6Lck3K704eEdhgFgzt9NstotWQLyG9zFM,401
 src/clients/common/document.py,sha256=ZzZiXDf_UhlN2FCmqW3drVjIZ07kGYP9yth_sgsJGPc,1623
+src/clients/common/general.py,sha256=_1eS11Ha-JC1x1YoSu63zUWXKvYkwvN8RQOUM1fx39M,469
 src/clients/common/index.py,sha256=vyH5iXlJe5JLcDK6fhCCEPN-tgGm6zP5ilwGPdWCXbY,776
-src/tools/__init__.py,sha256=qiMRNUKlpNGnqbrkgBHGa7El1Pw_0a2qUJnuk_Q8LtY,324
+src/tools/__init__.py,sha256=PGsXXpPubVnUbzXJG4keDhgjr0j6EnMNDs0aLqNIb4A,387
 src/tools/alias.py,sha256=p9TD4gXkGRGWHTYfvCg7G2hj-Uch9jwDXJNUY1hSD0Y,1376
 src/tools/cluster.py,sha256=XRAG-uxdfrieYX1ov_cBb66IYXaa8OoSWCUfXvNauy0,587
 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.2.dist-info/METADATA,sha256=G1phXdISE1LdPqcw9087IDXr4YXLYuEsXuF2OHr8S-o,18514
-opensearch_mcp_server-2.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-opensearch_mcp_server-2.0.2.dist-info/entry_points.txt,sha256=ImfJnUwMpQUBmu-1MeBG_P0dwamfXKQh82mBKW7tWNY,138
-opensearch_mcp_server-2.0.2.dist-info/licenses/LICENSE,sha256=DBsjuP5FR51d9kaUdXlVBuBv3cQ_I_adq9gefYQ9FcY,11339
-opensearch_mcp_server-2.0.2.dist-info/RECORD,,
+opensearch_mcp_server-2.0.3.dist-info/METADATA,sha256=OFMMCH1mufu1PkUACANPjp0fzWu3NSTtH6gVccB67r4,18716
+opensearch_mcp_server-2.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+opensearch_mcp_server-2.0.3.dist-info/entry_points.txt,sha256=ImfJnUwMpQUBmu-1MeBG_P0dwamfXKQh82mBKW7tWNY,138
+opensearch_mcp_server-2.0.3.dist-info/licenses/LICENSE,sha256=DBsjuP5FR51d9kaUdXlVBuBv3cQ_I_adq9gefYQ9FcY,11339
+opensearch_mcp_server-2.0.3.dist-info/RECORD,,

src/clients/base.py

@@ -3,6 +3,10 @@ import logging
 import warnings
 from typing import Dict
 
+from elasticsearch import Elasticsearch
+import httpx
+from opensearchpy import OpenSearch
+
 class SearchClientBase(ABC):
     def __init__(self, config: Dict, engine_type: str):
         """
@@ -35,7 +39,6 @@ class SearchClientBase(ABC):
         
         # Initialize client based on engine type
         if engine_type == "elasticsearch":
-            from elasticsearch import Elasticsearch
             self.client = Elasticsearch(
                 hosts=hosts,
                 basic_auth=(username, password) if username and password else None,
@@ -43,7 +46,6 @@ class SearchClientBase(ABC):
             )
             self.logger.info(f"Elasticsearch client initialized with hosts: {hosts}")
         elif engine_type == "opensearch":
-            from opensearchpy import OpenSearch
             self.client = OpenSearch(
                 hosts=hosts,
                 http_auth=(username, password) if username and password else None,
@@ -52,3 +54,34 @@ class SearchClientBase(ABC):
             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,
+            verify_certs=verify_certs,
+        )
+
+class GeneralRestClient:
+    def __init__(self, base_url: str, username: str, password: str, verify_certs: bool):
+        self.base_url = base_url.rstrip("/")
+        self.auth = (username, password) if username and password else None
+        self.verify_certs = verify_certs
+
+    def request(self, method, path, params=None, body=None):
+        url = f"{self.base_url}/{path.lstrip('/')}"
+        with httpx.Client(verify=self.verify_certs) as client:
+            resp = client.request(
+                method=method.upper(),
+                url=url,
+                params=params,
+                json=body,
+                auth=self.auth
+            )
+            resp.raise_for_status()
+            ct = resp.headers.get("content-type", "")
+            if ct.startswith("application/json"):
+                return resp.json()
+            return resp.text

src/clients/common/client.py

@@ -3,9 +3,10 @@ from typing import Dict
 from src.clients.common.alias import AliasClient
 from src.clients.common.cluster import ClusterClient
 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):
+class SearchClient(IndexClient, DocumentClient, ClusterClient, AliasClient, GeneralClient):
     """
     Unified search client that combines all search functionality.
     

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/server.py

@@ -2,11 +2,13 @@ import logging
 import sys
 
 from fastmcp import FastMCP
+import toml
 
 from src.clients import create_search_client
 from src.tools.alias import AliasTools
 from src.tools.cluster import ClusterTools
 from src.tools.document import DocumentTools
+from src.tools.general import GeneralTools
 from src.tools.index import IndexTools
 from src.tools.register import ToolsRegister
 
@@ -17,7 +19,8 @@ class SearchMCPServer:
         self.name = f"{self.engine_type}_mcp_server"
         self.mcp = FastMCP(self.name)
         self.logger = logging.getLogger()
-        self.logger.info(f"Initializing {self.name}...")
+        self.version = toml.load("pyproject.toml")["project"]["version"]
+        self.logger.info(f"Initializing {self.name}, Version: {self.version}")
         
         # Create the corresponding search client
         self.search_client = create_search_client(self.engine_type)
@@ -35,7 +38,8 @@ class SearchMCPServer:
             IndexTools,
             DocumentTools,
             ClusterTools,
-            AliasTools
+            AliasTools,
+            GeneralTools,
         ]        
         # Register all tools
         register.register_all_tools(tool_classes)

src/tools/__init__.py

@@ -1,13 +1,15 @@
-from src.tools.index import IndexTools
-from src.tools.document import DocumentTools
-from src.tools.cluster import ClusterTools
 from src.tools.alias import AliasTools
+from src.tools.cluster import ClusterTools
+from src.tools.document import DocumentTools
+from src.tools.general import GeneralTools
+from src.tools.index import IndexTools
 from src.tools.register import ToolsRegister
 
 __all__ = [
-    'IndexTools',
-    'DocumentTools',
-    'ClusterTools',
     'AliasTools',
+    'ClusterTools',
+    'DocumentTools',
+    'GeneralTools',
+    'IndexTools',
     'ToolsRegister',
 ]

src/tools/general.py

@@ -0,0 +1,20 @@
+from typing import Dict, Optional
+
+from fastmcp import FastMCP
+
+class GeneralTools:
+    def __init__(self, search_client):
+        self.search_client = search_client
+    def register_tools(self, mcp: FastMCP):
+        @mcp.tool()
+        def general_api_request(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.
+            
+            Args:
+                method: HTTP method (GET, POST, PUT, DELETE, etc.)
+                path: API endpoint path
+                params: Query parameters
+                body: Request body
+            """
+            return self.search_client.general_api_request(method, path, params, body)