How to install elasticsearch-onboarding
npx skills add https://github.com/elastic/agent-skills --skill elasticsearch-onboardingClaude Code
Cursor
Windsurf
Cline
Full instructions (SKILL.md)
Source of truth, from elastic/agent-skills.
name: elasticsearch-onboarding description: > Help 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. compatibility: Elasticsearch 9.x metadata: author: elastic version: 0.1.0
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.
Related skills
More from elastic/agent-skills and the wider catalog.
EL
elasticsearch-esql
elastic/agent-skills
>
2.1k installs
KI
kibana-dashboards
elastic/agent-skills
>
1.8k installs
SE
security-case-management
elastic/agent-skills
>
1.7k installs
OB
observability-logs-search
elastic/agent-skills
>
1.7k installs
EL
elasticsearch-authn
elastic/agent-skills
>
1.7k installs
EL
elasticsearch-file-ingest
elastic/agent-skills
>
1.6k installs