opensearch-mcp-server 2.0.0__tar.gz → 2.0.1__tar.gz

{opensearch_mcp_server-2.0.0 → opensearch_mcp_server-2.0.1}/.env.example

@@ -2,8 +2,10 @@
 ELASTICSEARCH_HOSTS=https://localhost:9200
 ELASTICSEARCH_USERNAME=elastic
 ELASTICSEARCH_PASSWORD=test123
+ELASTICSEARCH_VERIFY_CERTS=false
 
 # OpenSearch connection settings
 OPENSEARCH_HOSTS=https://localhost:9200
 OPENSEARCH_USERNAME=admin
 OPENSEARCH_PASSWORD=admin
+OPENSEARCH_VERIFY_CERTS=false

opensearch_mcp_server-2.0.1/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing to Elasticsearch/OpenSearch MCP Server
+
+Thank you for your interest in contributing to the Elasticsearch/OpenSearch MCP Server! All kinds of contributions are welcome.
+
+## Bug reports
+
+If you think you've found a bug in the Elasticsearch/OpenSearch MCP Server, we welcome your report. It's very helpful if you can provide steps to reproduce the bug, as it makes it easier to identify and fix the issue.
+
+## Feature requests
+
+If you find yourself wishing for a feature that doesn't exist in the Elasticsearch/OpenSearch MCP Server, you are probably not alone. Don't be hesitate to open an issue which describes the feature you would like to see, why you need it, and how it should work.
+
+## Pull requests
+
+If you have a fix or a new feature, we welcome your pull requests. You can follow the following steps:
+
+1. Fork your own copy of the repository to your GitHub account by clicking on
+   `Fork` button on [elasticsearch-mcp-server's GitHub repository](https://github.com/cr7258/elasticsearch-mcp-server).
+2. Clone the forked repository on your local setup.
+
+    ```bash
+    git clone https://github.com/$user/elasticsearch-mcp-server
+    ```
+
+   Add a remote upstream to track upstream `elasticsearch-mcp-server` repository.
+
+    ```bash
+    git remote add upstream https://github.com/cr7258/elasticsearch-mcp-server
+    ```
+
+3. Create a topic branch.
+
+    ```bash
+    git checkout -b <branch-name>
+    ```
+
+4. Make changes and commit it locally.
+
+    ```bash
+    git add <modifiedFile>
+    git commit
+    ```
+
+Commit message could help reviewers better understand what is the purpose of submitted PR. It could help accelerate the code review procedure as well. We encourage contributors to use **EXPLICIT** commit message rather than ambiguous message. In general, we advocate the following commit message type:
+- Features: commit message start with `feat`, For example: "feat: add user authentication module"
+- Bug Fixes: commit message start with `fix`, For example: "fix: resolve null pointer exception in user service"
+- Documentation, commit message start with `doc`, For example: "doc: update API documentation for user endpoints"
+- Performance: commit message start with `perf`, For example: "perf: improve the performance of user service"
+- Refactor: commit message start with `refactor`, For example: "refactor: refactor user service to improve code readability"
+- Test: commit message start with `test`, For example: "test: add unit test for user service"
+- Chore: commit message start with `chore`, For example: "chore: update dependencies in pom.xml"
+- Style: commit message start with `style`, For example: "style: format the code in user service"
+- Revert: commit message start with `revert`, For example: "revert: revert the changes in user service"
+
+5. Push local branch to your forked repository.
+
+    ```bash
+    git push
+    ```
+
+6. Create a Pull request on GitHub.
+   Visit your fork at `https://github.com/$user/elasticsearch-mcp-server` and click
+   `Compare & Pull Request` button next to your `<branch-name>`.
+
+
+## Keeping branch in sync with upstream
+
+Click `Sync fork` button on your forked repository to keep your forked repository in sync with the upstream repository. 
+
+If you have already created a branch and want to keep it in sync with the upstream repository, follow the below steps:
+
+```bash
+git checkout <branch-name>
+git fetch upstream
+git rebase upstream/main
+```

{opensearch_mcp_server-2.0.0 → opensearch_mcp_server-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensearch-mcp-server
-Version: 2.0.0
+Version: 2.0.1
 Summary: MCP Server for interacting with Elasticsearch and OpenSearch
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -302,7 +302,7 @@ Using `uvx` will automatically install the package from PyPI, no need to clone t
         "elasticsearch-mcp-server"
       ],
       "env": {
-        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_HOSTS": "https://localhost:9200",
         "ELASTICSEARCH_USERNAME": "elastic",
         "ELASTICSEARCH_PASSWORD": "test123"
       }
@@ -319,7 +319,7 @@ Using `uvx` will automatically install the package from PyPI, no need to clone t
         "opensearch-mcp-server"
       ],
       "env": {
-        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_HOSTS": "https://localhost:9200",
         "OPENSEARCH_USERNAME": "admin",
         "OPENSEARCH_PASSWORD": "admin"
       }
@@ -345,7 +345,7 @@ Using `uv` requires cloning the repository locally and specifying the path to th
         "elasticsearch-mcp-server"
       ],
       "env": {
-        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_HOSTS": "https://localhost:9200",
         "ELASTICSEARCH_USERNAME": "elastic",
         "ELASTICSEARCH_PASSWORD": "test123"
       }
@@ -365,7 +365,7 @@ Using `uv` requires cloning the repository locally and specifying the path to th
         "opensearch-mcp-server"
       ],
       "env": {
-        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_HOSTS": "https://localhost:9200",
         "OPENSEARCH_USERNAME": "admin",
         "OPENSEARCH_PASSWORD": "admin"
       }

{opensearch_mcp_server-2.0.0 → opensearch_mcp_server-2.0.1}/README.md

@@ -85,7 +85,7 @@ Using `uvx` will automatically install the package from PyPI, no need to clone t
         "elasticsearch-mcp-server"
       ],
       "env": {
-        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_HOSTS": "https://localhost:9200",
         "ELASTICSEARCH_USERNAME": "elastic",
         "ELASTICSEARCH_PASSWORD": "test123"
       }
@@ -102,7 +102,7 @@ Using `uvx` will automatically install the package from PyPI, no need to clone t
         "opensearch-mcp-server"
       ],
       "env": {
-        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_HOSTS": "https://localhost:9200",
         "OPENSEARCH_USERNAME": "admin",
         "OPENSEARCH_PASSWORD": "admin"
       }
@@ -128,7 +128,7 @@ Using `uv` requires cloning the repository locally and specifying the path to th
         "elasticsearch-mcp-server"
       ],
       "env": {
-        "ELASTICSEARCH_HOST": "https://localhost:9200",
+        "ELASTICSEARCH_HOSTS": "https://localhost:9200",
         "ELASTICSEARCH_USERNAME": "elastic",
         "ELASTICSEARCH_PASSWORD": "test123"
       }
@@ -148,7 +148,7 @@ Using `uv` requires cloning the repository locally and specifying the path to th
         "opensearch-mcp-server"
       ],
       "env": {
-        "OPENSEARCH_HOST": "https://localhost:9200",
+        "OPENSEARCH_HOSTS": "https://localhost:9200",
         "OPENSEARCH_USERNAME": "admin",
         "OPENSEARCH_PASSWORD": "admin"
       }

{opensearch_mcp_server-2.0.0 → opensearch_mcp_server-2.0.1}/docker-compose-elasticsearch.yml

@@ -1,6 +1,6 @@
 services:
   setup:
-    image: docker.elastic.co/elasticsearch/elasticsearch:8.6.1
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.17.2
     volumes:
       - certs:/usr/share/elasticsearch/config/certs
     user: "0"
@@ -61,7 +61,7 @@ services:
     depends_on:
       setup:
         condition: service_healthy
-    image: docker.elastic.co/elasticsearch/elasticsearch:8.6.1
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.17.2
     volumes:
       - certs:/usr/share/elasticsearch/config/certs
       - esdata01:/usr/share/elasticsearch/data
@@ -106,7 +106,7 @@ services:
   es02:
     depends_on:
       - es01
-    image: docker.elastic.co/elasticsearch/elasticsearch:8.6.1
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.17.2
     volumes:
       - certs:/usr/share/elasticsearch/config/certs
       - esdata02:/usr/share/elasticsearch/data
@@ -148,7 +148,7 @@ services:
   es03:
     depends_on:
       - es02
-    image: docker.elastic.co/elasticsearch/elasticsearch:8.6.1
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.17.2
     volumes:
       - certs:/usr/share/elasticsearch/config/certs
       - esdata03:/usr/share/elasticsearch/data
@@ -195,7 +195,7 @@ services:
         condition: service_healthy
       es03:
         condition: service_healthy
-    image: docker.elastic.co/kibana/kibana:8.6.1
+    image: docker.elastic.co/kibana/kibana:8.17.2
     volumes:
       - certs:/usr/share/kibana/config/certs
       - kibanadata:/usr/share/kibana/data

opensearch_mcp_server-2.0.1/mcp_client/spring-ai/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Tue Apr 22 12:36:29 CST 2025
+gradle.version=8.13

opensearch_mcp_server-2.0.1/mcp_client/spring-ai/README.md

@@ -0,0 +1,54 @@
+## Start MCP Client
+
+```bash
+export OPENAI_API_KEY=<your-openai-api-key>
+export OPENAI_BASE_URL=<your-openai-base-url>
+./gradlew bootRun
+```
+
+## Ask Questions
+
+```bash
+USER: List the indices in the cluster.
+ASSISTANT: Here are the indices currently present in the cluster:
+
+1. `.internal.alerts-default.alerts-default-000001`
+2. `.internal.alerts-observability.threshold.alerts-default-000001`
+3. `.internal.alerts-ml.anomaly-detection-health.alerts-default-000001`
+4. `.internal.alerts-observability.metrics.alerts-default-000001`
+5. `.internal.alerts-stack.alerts-default-000001`
+6. `.internal.alerts-security.alerts-default-000001`
+7. `.internal.alerts-observability.slo.alerts-default-000001`
+8. `.internal.alerts-ml.anomaly-detection.alerts-default-000001`
+9. `.internal.alerts-transform.health.alerts-default-000001`
+10. `student`
+11. `.internal.alerts-observability.logs.alerts-default-000001`
+12. `.internal.alerts-observability.uptime.alerts-default-000001`
+13. `.internal.alerts-observability.apm.alerts-default-000001`
+
+If you need more information about any specific index, feel free to ask!
+
+USER: Get student index's mapping.
+ASSISTANT: The mapping for the `student` index is as follows:
+
+- **Mappings:**
+  - **Properties:**
+    - **age:** Type is `long`
+    - **major:** Type is `text` with a sub-field `keyword` of type `keyword`, and `ignore_above` set to 256.
+    - **name:** Type is `text` with a sub-field `keyword` of type `keyword`, and `ignore_above` set to 256.
+
+- **Settings:**
+  - **Index:**
+    - Routing:
+      - Allocation:
+        - Include:
+          - `_tier_preference`: `data_content`
+    - Number of shards: `1`
+    - Provided name: `student`
+    - Creation date: `1745300793755`
+    - Number of replicas: `1`
+    - UUID: `RIsbajmcSwKr8DGFjL0sMQ`
+    - Version created: `8521000`
+
+If you need further details or have any other questions, feel free to ask!
+```