OpenSearch MCP Search
Search documents, run aggregations, inspect index mappings and check cluster health in OpenSearch.
Quick start
- Add a OpenSearch connection with the settings below, then click Test configuration.
- Create an API key for your agent.
- Paste the key below, click Test endpoint, and copy the configuration for your platform.
| Endpoint | https://market.oshaani.com/opensearch (your default connection) or https://market.oshaani.com/opensearch/<connection-id> |
|---|---|
| Transport | Streamable HTTP (stateless, JSON responses). MCP protocol versions 2024-11-05 to 2025-11-25 and 2026-07-28. |
| Authentication | Authorization: Bearer <API key>, using a key from the API keys page. |
Agent configuration
initialize and tools/list against the endpoint, exactly like an agent. No credits are charged.
Any MCP client that supports remote (Streamable HTTP) servers with custom headers.
{
"name": "opensearch",
"transport": "streamable-http",
"url": "https://market.oshaani.com/opensearch",
"headers": {
"Authorization": "Bearer YOUR_API_KEY"
}
}
~/.cursor/mcp.json (all projects) or .cursor/mcp.json in a project.
{
"mcpServers": {
"opensearch": {
"url": "https://market.oshaani.com/opensearch",
"headers": {
"Authorization": "Bearer YOUR_API_KEY"
}
}
}
}
Settings > Developer > Edit Config (claude_desktop_config.json). Uses the mcp-remote bridge; needs Node.js.
{
"mcpServers": {
"opensearch": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://market.oshaani.com/opensearch",
"--header",
"Authorization:${AUTH_HEADER}"
],
"env": {
"AUTH_HEADER": "Bearer YOUR_API_KEY"
}
}
}
}
Run in your terminal, or put the JSON in .mcp.json at the project root.
claude mcp add --transport http opensearch https://market.oshaani.com/opensearch \
--header "Authorization: Bearer YOUR_API_KEY"
# .mcp.json
{
"mcpServers": {
"opensearch": {
"type": "http",
"url": "https://market.oshaani.com/opensearch",
"headers": {
"Authorization": "Bearer YOUR_API_KEY"
}
}
}
}
.vscode/mcp.json (GitHub Copilot agent mode). VS Code prompts for the key once and stores it securely.
{
"inputs": [
{
"type": "promptString",
"id": "oshaani-mcp-key",
"description": "oshaani MCP Marketplace API key",
"password": true
}
],
"servers": {
"opensearch": {
"type": "http",
"url": "https://market.oshaani.com/opensearch",
"headers": {
"Authorization": "Bearer ${input:oshaani-mcp-key}"
}
}
}
}
~/.codeium/windsurf/mcp_config.json
{
"mcpServers": {
"opensearch": {
"serverUrl": "https://market.oshaani.com/opensearch",
"headers": {
"Authorization": "Bearer YOUR_API_KEY"
}
}
}
}
Responses API remote MCP tool (Python SDK).
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="gpt-4.1",
tools=[{
"type": "mcp",
"server_label": "opensearch",
"server_url": "https://market.oshaani.com/opensearch",
"headers": {"Authorization": "Bearer YOUR_API_KEY"},
"require_approval": "never", # or "always" to approve each tool call
}],
input="What can you do with these tools?",
)
print(response.output_text)
Messages API MCP connector (Python SDK).
import anthropic
client = anthropic.Anthropic()
response = client.beta.messages.create(
model="claude-sonnet-4-5",
max_tokens=1024,
messages=[{"role": "user", "content": "What can you do with these tools?"}],
mcp_servers=[{
"type": "url",
"url": "https://market.oshaani.com/opensearch",
"name": "opensearch",
"authorization_token": "YOUR_API_KEY",
}],
betas=["mcp-client-2025-04-04"],
)
print(response.content)
Official MCP Python SDK 2.x (pip install mcp); works inside any agent framework.
import asyncio
from mcp import ClientSession
from mcp.client.streamable_http import create_mcp_http_client, streamable_http_client
async def main():
headers = {"Authorization": "Bearer YOUR_API_KEY"}
async with create_mcp_http_client(headers=headers) as http:
async with streamable_http_client("https://market.oshaani.com/opensearch", http_client=http) as (read, write, *_):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
print([tool.name for tool in tools.tools])
asyncio.run(main())
Quick check from a terminal: lists the tools without charging credits.
curl -s https://market.oshaani.com/opensearch \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json, text/event-stream" \
-H "MCP-Protocol-Version: 2025-06-18" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
Connection settings
Entered once per connection on market.oshaani.com. Secrets are encrypted and never shown again or sent to agents.
| Setting | Type | Description |
|---|---|---|
OpenSearch URLurl
required |
string (uri) | e.g. https://search-mydomain.eu-west-1.es.amazonaws.com or your self-managed cluster min length 1, max length 2083 |
Usernameusername
|
string | An internal user with read access (Amazon OpenSearch Service: enable fine-grained access control) |
Passwordpassword
|
string | |
Verify TLS certificateverify_tls
|
boolean default true |
Tools (6)
cluster_health
read-only
Get cluster health, version and node/shard counts
No arguments.
list_indices
read-only
List indices with health, document count and size
| Argument | Type | Description |
|---|---|---|
pattern |
string default "*" |
Index, alias, data stream or pattern, e.g. logs-* or orders,customers max length 1000, pattern ^[^/\\?#\s\"<>|]+$ |
include_hidden |
boolean default false |
Include system/hidden indices (names starting with '.') |
limit |
integer default 200 |
min 1, max 1000 |
get_mapping
read-only
Get the field names and types of an index
| Argument | Type | Description |
|---|---|---|
index required |
string | Index, alias, data stream or pattern, e.g. logs-* or orders,customers max length 1000, pattern ^[^/\\?#\s\"<>|]+$ |
search
read-only
Search documents with Query DSL or a query string, with optional aggregations
| Argument | Type | Description |
|---|---|---|
index required |
string | Index, alias, data stream or pattern, e.g. logs-* or orders,customers max length 1000, pattern ^[^/\\?#\s\"<>|]+$ |
query |
object | Query DSL object, e.g. {"match": {"message": "timeout"}} |
query_string |
string | Lucene query string, e.g. 'status:500 AND service:api' (used when query is omitted) |
size |
integer default 10 |
Number of hits to return; 0 for aggregations only min 0, max 100 |
sort |
array of object | e.g. [{"@timestamp": "desc"}] |
source_fields |
array of string | Only return these fields of each document |
aggs |
object | Aggregations object |
count
read-only
Count documents matching a query
| Argument | Type | Description |
|---|---|---|
index required |
string | Index, alias, data stream or pattern, e.g. logs-* or orders,customers max length 1000, pattern ^[^/\\?#\s\"<>|]+$ |
query |
object | Query DSL object, e.g. {"match": {"message": "timeout"}} |
get_document
read-only
Get a single document by ID
| Argument | Type | Description |
|---|---|---|
index required |
string | pattern ^[^/\\?#\s\"<>|,*]+$ |
document_id required |
string | min length 1, max length 512 |
Billing & errors
Each successful tool call costs 1 oshaani.com credit. initialize, tools/list, failed calls and timeouts are free.
| JSON-RPC code | Meaning |
|---|---|
-32054 (HTTP 401) | Missing, unknown or revoked API key |
-32053 (HTTP 404) | No OpenSearch connection configured for your organisation, or the connection ID is wrong |
-32055 (HTTP 403) | Connection disabled or origin not allowed |
-32052 (HTTP 429) | Rate limit reached; retry after a minute |
-32050 | Not enough oshaani.com credits for the call |
-32051 | Billing temporarily unavailable; the call was not run |
Errors from OpenSearch itself (bad IDs, permissions) come back as tool results with isError: true so the agent can read and correct them.
See the OpenSearch API documentation.