Skip to main content

MCP Server for interacting with OpenSearch

Project description

OpenSearch MCP Server

Overview

This Repository Fork of elastic-mcp-server and Converted to opensearch-mcp-server MCP Server. It is a Model Context Protocol (MCP) server implementation that provides opensearch 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 opensearch interaction. This server enables searching documents, analyzing indices, and managing cluster through a set of tools.

Features

Index Operations

  • list_indices: List all indices in the Opensearch cluster.
  • get_mapping: Retrieve the mapping configuration for a specific index.
  • get_settings: Get the settings configuration for a specific index.

Document Operations

  • search_documents: Search documents in an index using Opensearch Query DSL.

Cluster Operations

  • get_cluster_health: Get health status of the cluster.
  • get_cluster_stats: Get statistical information about the cluster.

Start Opensearch Cluster

Start the Opensearch cluster using Docker Compose:

docker-compose up -d

This will start a 3-node Opensearch cluster and Kibana. Default Opensearch username opensearch, password test123.

You can access Kibana from http://localhost:5601.

Usage with Claude Desktop

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.

you need to change path/to/src/opensearch_mcp_server to the path where you cloned the repository.

{
  "mcpServers": {
    "opensearch": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/src/opensearch_mcp_server",
        "run",
        "opensearch-mcp-server"
      ],
      "env": {
        "OPENSEARCH_HOST": "https://localhost:9200",
        "OPENSEARCH_USERNAME": "opensearch",
        "OPENSEARCH_PASSWORD": "test123",
        "DASHBOARDS_HOST": "https://localhost:5601"
      }
    }
  }
}
  • 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 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"

License

This project is licensed under the Apache License Version 2.0 - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file iflow_mcp_seohyunjun_opensearch_mcp_server-1.0.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_seohyunjun_opensearch_mcp_server-1.0.0.tar.gz
  • Upload date:
  • Size: 35.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_seohyunjun_opensearch_mcp_server-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4f1eb908a90a9547f9ca2d533989f56e82aeaacad70488dbb3c15178d0f60cfe
MD5 920a378a14a8d4a613d0887a52116924
BLAKE2b-256 0ac2ceea1b09ee3ef30bff65707ff9ad991332b58ab493a6bb64e5780ca78f2d

See more details on using hashes here.

File details

Details for the file iflow_mcp_seohyunjun_opensearch_mcp_server-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_seohyunjun_opensearch_mcp_server-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_seohyunjun_opensearch_mcp_server-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bbdf9adfed7664b9181e5f8305476cb4b7ee30a2dfd88af0d5650066e3790eb0
MD5 b4526c5eab80e59931acb38ca10d2e4e
BLAKE2b-256 90a4ec0478808627dd7914444f3e7f7c5ea109880c27c2ddb276069fc9270967

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page