ElasticBackendSKILL.mdVerified source

Agent Skill

Elasticsearch onboarding

Turn a search use case and sample data into a working Elasticsearch search experience.

elasticsearchsearchonboarding

Skill specification

Declared by Elastic in the package front matter. Trigger conditions are what the coding agent matches on before it loads the skill.

Elasticsearch onboarding SKILL.md front matter fields
Skill nameelasticsearch-onboarding
Trigger conditionsHelp developers new to Elasticsearch get from zero to a working search experience. Guide them through understanding their intent, mapping their data, and building a search experience with best practices baked in. Use this when the user shows intent to build search-related functionality, asks about Elasticsearch-related concepts for their use case, or expresses the need for help getting started with Elasticsearch.
CompatibilityElasticsearch 9.x
Version0.1.0
Authorelastic

Install elasticsearch-onboarding

Agent Skills are a shared file format, but each client discovers them from a different directory. Copy the command for your agent, then start a new session so the skill is picked up.

Claude Code

.claude/skills/elasticsearch-onboarding/SKILL.md

Project skills are committed with the repo. Use the user directory for a personal install across every project.

Project install

mkdir -p .claude/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o .claude/skills/elasticsearch-onboarding/SKILL.md

Personal install

mkdir -p ~/.claude/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o ~/.claude/skills/elasticsearch-onboarding/SKILL.md

Codex

.agents/skills/elasticsearch-onboarding/SKILL.md

Codex reads `.agents/skills/` as its primary location, which is also the cross-platform default other clients honour.

Project install

mkdir -p .agents/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o .agents/skills/elasticsearch-onboarding/SKILL.md

Personal install

mkdir -p ~/.agents/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o ~/.agents/skills/elasticsearch-onboarding/SKILL.md

Cursor

.cursor/skills/elasticsearch-onboarding/SKILL.md

Cursor also loads `.agents/skills/`, `.claude/skills/`, and `.codex/skills/`, so one committed copy can serve several clients.

Project install

mkdir -p .cursor/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o .cursor/skills/elasticsearch-onboarding/SKILL.md

Personal install

mkdir -p ~/.cursor/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o ~/.cursor/skills/elasticsearch-onboarding/SKILL.md

Gemini CLI

.gemini/skills/elasticsearch-onboarding/SKILL.md

Gemini CLI reads `.agents/skills/` first when both directories exist.

Project install

mkdir -p .gemini/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o .gemini/skills/elasticsearch-onboarding/SKILL.md

Personal install

mkdir -p ~/.gemini/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o ~/.gemini/skills/elasticsearch-onboarding/SKILL.md

GitHub Copilot

.github/skills/elasticsearch-onboarding/SKILL.md

Copilot in VS Code discovers repository skills from `.github/skills/`.

Project install

mkdir -p .github/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o .github/skills/elasticsearch-onboarding/SKILL.md

Personal install

mkdir -p ~/.copilot/skills/elasticsearch-onboarding && curl -fsSL 'https://raw.githubusercontent.com/elastic/agent-skills/main/plugins/elasticsearch/skills/elasticsearch-onboarding/SKILL.md' -o ~/.copilot/skills/elasticsearch-onboarding/SKILL.md

Published by Elastic under Apache-2.0. Rendered from the package in github.com/elastic/agent-skills/tree/main/plugins/elasticsearch/skills/elasticsearch-onboarding.

Elastic Developer Guide

You are an Elasticsearch solutions architect working alongside the developer. Your job is to guide developers from "I want search" to a working search experience — understanding their intent, recommending the right approach, and generating tested, production-ready code. Use the conversation playbook in references/elasticsearch-onboarding-playbook.md to structure the conversation. Always ask one question at a time, listen for signals, and adapt your recommendations to their specific use case and data shape.

Examples

Example user intents that should trigger this skill:

  • "I want to build a search experience for my e-commerce site"
  • "How do I get started with Elasticsearch?"
  • "What are the best practices for building a search experience?"
  • "Can you help me understand how to model my data for search?"
  • "How do I build a vector database?"
  • "I want to build a RAG pipeline with Elasticsearch"
  • "How do I use EIS for embeddings?"
  • "How do I connect an LLM to Elasticsearch?"
  • "How do I do kNN search in Elasticsearch?"
  • "How do I use ELSER for semantic search?"
  • "How do I set up the Elasticsearch MCP?"
  • "How do I combine keyword and vector results with RRF?"
  • "I want NLP-powered search"
  • "What's the difference between BM25 and vector search?"
  • "Can I use ES|QL to query my data?"

Guidelines

  • Ask one question at a time, then wait.
  • Only generate code once the user confirms the approach and the mapping.
  • Use the Synonyms API for synonym management, not a custom-built solution.
  • Always use a versioned index name + alias (e.g. products_v1 + products_current) and explain why.
  • Explain decisions briefly, assume the user does not understand Elasticsearch yet.
  • Always go through the mapping walkthrough — it's the most expensive thing to change later.
  • Ask what programming language the user wants to use, don't assume.
  • Avoid generating code with deprecated APIs. If you must use a deprecated API for some reason, explain why and warn about future compatibility issues.

Add the registry badge

Maintainers can link this listing from the skill's own README. Free, no account needed, and it points back at the rendered package for anyone browsing the repo.

Markdown

[![Elasticsearch onboarding on tokens&](https://tokensand.com/api/badges/skill/elastic-elasticsearch-onboarding)](https://tokensand.com/agent-skills/elastic-elasticsearch-onboarding)

HTML

<a href="https://tokensand.com/agent-skills/elastic-elasticsearch-onboarding" target="_blank" rel="noopener">
  <img src="https://tokensand.com/api/badges/skill/elastic-elasticsearch-onboarding" alt="Elasticsearch onboarding on tokens&" />
</a>

More Elastic Agent Skills

All Agent Skills