elasticsearch-mcp: Instructions file for Claude Code

CLAUDE.md

elasticsearch-mcp CLAUDE.md is an instructions file for Claude Code from bpamiri/elasticsearch-mcp. It costs 1,408 tokens per session, scanned A, original, Apache-2.0.

A project instruction file for an MCP server that lets AI assistants work with Elasticsearch. Elasticsearch is a system for searching and analyzing stored data.

In plain words
What is it for?
Use it when developing or maintaining the elasticsearch-mcp Python server, including its search, aggregation, index-management, or cluster-operation tools.
Why use it?
It documents setup, tests, formatting, linting, type checking, project structure, and the ways the server can communicate with clients.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is bpamiri/elasticsearch-mcp's own configuration. It tells Claude Code how to work on elasticsearch-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything elasticsearch-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to bpamiri/elasticsearch-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/bpamiri/elasticsearch-mcp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/bpamiri/elasticsearch-mcp

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for elasticsearch-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/bpamiri/elasticsearch-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/bpamiri/elasticsearch-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/bpamiri/elasticsearch-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/bpamiri/elasticsearch-mcp/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for elasticsearch-mcp CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/bpamiri/elasticsearch-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/bpamiri/elasticsearch-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,408 This file is loaded in full into every session.
When invoked 1,408 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01408 $0.01408
Opus 5 $0.00704 $0.00704
Sonnet 5 $0.00282 $0.00282
Haiku 4.5 $0.00141 $0.00141

Measured 10d ago against content hash 19665176716d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

elasticsearch-mcp CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 120 lines

How it starts

The opening of the file, as written. The whole thing — 120 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

elasticsearch-mcp is a Python MCP (Model Context Protocol) server that enables AI assistants to interact with Elasticsearch clusters. It uses the official elasticsearch Python client and provides tools for searching, aggregations, index management, and cluster operations.

Development Commands

pip install -e ".[dev]"                     # Install with dev dependencies

pytest                                      # All tests
pytest tests/test_config.py                 # Single file
pytest --cov=elasticsearch_mcp --cov-report=html    # With coverage

ruff check .                                # Lint
ruff format .                               # Format
mypy src/                                   # Type check

Architecture

Transport Modes

The server (server.py:main) supports three transport modes via CLI args:

  • stdio (default): elasticsearch-mcp — for Claude Desktop local connections
  • SSE (legacy): elasticsearch-mcp --http — HTTP/SSE for centralized deployment
  • Streamable HTTP: elasticsearch-mcp --streamable-http — for Claude.ai Integrations with OAuth

Tool Registration Pattern

Tools are registered via @mcp.tool() decorators on the module-level mcp FastMCP instance in server.py. Connection tools (connect, disconnect, cluster_health, etc.) are defined directly in server.py. Domain tools are implemented in tools/ modules and called from server.py tool wrappers.

Module Layout

src/elasticsearch_mcp/
├── server.py           # FastMCP instance, connection/cluster tools, CLI entry, transport modes
├── connection.py       # ConnectionManager: async connect/disconnect, health check
├── config.py           # Settings (pydantic-settings): all env vars including auth, watchdog, audit
├── auth/               # OAuth for Claude.ai Integrations (Streamable HTTP mode only)
│   ├── provider.py     # ESOAuthProvider: bridges Claude.ai DCR to external IdPs
│   ├── callback.py     # /oauth/callback route handler
│   ├── storage.py      # In-memory auth state (clients, codes, tokens, pending auths)
│   └── idp/            # Identity provider adapters
│       ├── base.py     # BaseIdPAdapter ABC (get_authorization_url, exchange_code, validate_token)
│       ├── duo.py      # Cisco Duo adapter
│       ├── auth0.py    # Auth0 adapter
│       └── oidc.py     # Generic OIDC adapter
├── tools/              # MCP tool implementations
│   ├── cluster.py      # cluster_health, cluster_info, list_nodes, cluster_stats
│   ├── indices.py      # list_indices, describe_index, get_index_stats, get_mappings, get_aliases
│   └── search.py       # search, search_simple, count, get_document, aggregate, terms_aggregation, date_histogram
├── resources/          # MCP resources (placeholder)
└── utils/              # Utility modules (placeholder)

Read the full file on GitHub · 120 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 10d ago First seen · 120 lines · 1,408 tokens per session scan A 19665176716d

Subscribe to this mod's changes

elasticsearch-mcp CLAUDE.md is an instructions file published in the GitHub repository bpamiri/elasticsearch-mcp (0 stars, last pushed 7mo ago), licensed Apache-2.0. It adds 1,408 tokens to every session, about $0.0070 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens