Skip to content
MongoDB Search & AI

MongoDB Search & AI Skill

MongoDB's official skill for choosing between Atlas Search, Vector Search and Hybrid Search, then building the right indexes and queries for the use case.

GitHub Docs

Install

Install with the skills CLI

One command for Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf and dozens of other agents. Needs Node.js; the skill is fetched straight from mongodb/agent-skills.

$ npx skills add mongodb/agent-skills --skill mongodb-search-and-ai

Run it in a terminal. The CLI finds the agents installed on your machine, asks which ones to add the skill to, and whether to install it into the folder you ran it from or for all your projects.

Other ways to install

Copy the whole skill folder — SKILL.md and any scripts or references beside it — into ~/.claude/skills/mongodb-search-and-ai/, where Claude Code picks it up in every project. Only git is needed.

tmp=$(mktemp -d) && \
  git clone --depth 1 --branch main https://github.com/mongodb/agent-skills.git "$tmp" && \
  mkdir -p ~/.claude/skills && \
  cp -R "$tmp"/skills/mongodb-search-and-ai ~/.claude/skills/mongodb-search-and-ai

No scripts or references next to it? Saving the SKILL.md alone as ~/.claude/skills/mongodb-search-and-ai/SKILL.md works too.

Using another agent? Its personal skills folder
Codex
~/.agents/skills/
Cursor
~/.cursor/skills/
GitHub Copilot
~/.copilot/skills/
Gemini CLI
~/.gemini/skills/
Windsurf
~/.codeium/windsurf/skills/
OpenCode
~/.config/opencode/skills/

About

  • Routes a use case to Atlas Search, Vector Search or Hybrid Search
  • Inspects databases, collections, schema, indexes and cluster version first
  • Asks clarifying questions instead of guessing at vague requirements
  • Describes and gets approval for indexes before creating them
  • Falls back to emitting index JSON when running read-only
  • Covers autocomplete, fuzzy matching, faceting and RAG retrieval

Atlas Search, Atlas Vector Search and hybrid retrieval solve overlapping problems, and picking the wrong one costs a rebuilt index rather than a tweaked query. This official MongoDB skill makes the agent do the selection properly before it writes anything.

Discovery before recommendation

The workflow starts with inspection, not with a suggestion: list-databases and list-collections to see what exists, collection-schema to read the field structure, collection-indexes to see what is already indexed, and atlas-inspect-cluster to learn the cluster's MongoDB version — because index features differ by version. If the request is vague, the skill has the agent ask what users are actually searching for, which fields hold the content, whether typo tolerance or filters or autocomplete are needed, before proposing anything.

Choosing the search type

It then routes the use case: Atlas Search for keyword matching with relevance scoring, fuzzy matching, autocomplete and typeahead, faceted filtering and language-specific analysis; Vector Search for semantic similarity, natural-language understanding, RAG retrieval and cross-modal search; Hybrid Search when the query genuinely needs both, such as combining a semantic concept with a lexical filter.

Guardrails

Indexes are described and approved before creation, never created silently. If the agent has no create/update/delete tools it recognises it is in read-only mode and hands back the complete index configuration JSON for the user to apply themselves, including through the Atlas UI — a genuinely useful behaviour when an agent is connected to production with read-only credentials.

It also covers text containment and substring matching, case-insensitive and multi-field search, and filtering across many fields with variable combinations. Part of MongoDB's official agent-skills collection, which also includes connection management, schema design, query optimisation, natural-language querying and Atlas Stream Processing.

SKILL.md

The instructions your agent loads, as published by MongoDB.

SKILL.md
name
mongodb-search-and-ai
description
Guides MongoDB users through implementing and optimizing Atlas Search (full-text), Vector Search (semantic), and Hybrid Search solutions. Use this skill when users need to build search functionality for text-based queries (autocomplete, fuzzy matching, faceted search), semantic similarity (embeddings, RAG applications), or combined approaches. Also use when users need text containment, substring matching ('contains', 'includes', 'appears in'), case-insensitive or multi-field text search, or filtering across many fields with variable combinations. Provides workflows for selecting the right search type, creating indexes, constructing queries, and optimizing performance using the MongoDB MCP server.
license
Apache-2.0
metadata
version: "1.0.0"

MongoDB Search and AI Recommendations Skill

You are helping MongoDB users implement, optimize, and troubleshoot Atlas Search (lexical), Vector Search (semantic), and Hybrid Search (combined) solutions. Your goal is to understand their use case, recommend the appropriate search approach, and help them build effective indexes and queries.

Core Principles
  1. Understand before building - Validate the use case to ensure you recommend the right solution
  2. Always inspect first - Check existing indexes and schema before making recommendations
  3. Explain before executing - Describe what indexes will be created and require explicit approval
  4. Optimize for the use case - Different use cases require different index configurations and query patterns
  5. Handle read-only scenarios - If you do not have access to create, update, or delete operation tools, you are in read-only mode. Provide the complete index configuration JSON so the user can create it themselves, including via the Atlas UI.
Workflow
1. Discovery Phase

Check the environment:

  • Use list-databases and list-collections to understand available data
  • If the user mentions a collection, use collection-schema to inspect field structure
  • Use collection-indexes to see existing indexes
  • Use atlas-inspect-cluster to determine the cluster's MongoDB version

Understand the use case:
If the user's request is vague:

  • Ask clarifying questions about their needs
  • Infer likely collection and fields from schema
  • Confirm understanding before proceeding

Common questions to ask:

  • What are users searching for? (products, movies, documents, etc.)
  • What fields contain the searchable content?
  • Do they need exact matching, fuzzy matching, or semantic similarity?
  • Do they need filters (price ranges, categories, dates)?
  • Do they need autocomplete/typeahead functionality?
2. Determine Search Type

Atlas Search (Lexical/Full-Text):
Use when users need:

  • Keyword matching with relevance scoring
  • Fuzzy matching for typo tolerance
  • Autocomplete/typeahead
  • Faceted search with filters
  • Language-specific text analysis
  • Token-based search
  • Lexical search with views

Vector Search (Semantic):
Use when users need:

  • Semantic similarity ("find movies about coming of age stories")
  • Natural language understanding
  • RAG (Retrieval Augmented Generation) applications
  • Finding conceptually similar items
  • Cross-modal search
  • Vector search with views

Hybrid Search:
Use when users need:

  • Combining multiple search approaches (e.g., vector + lexical, multiple text searches)
  • Queries like "find action movies similar to 'epic space battles'" (combining keyword filtering with semantic similarity)
  • Results that factor in multiple relevance criteria
  • Uses $rankFusion (rank-based) or $scoreFusion (score-based) to merge pipelines
3. Version Check (Hybrid Search only)

If the search type is Hybrid using `$rankFusion` or `$scoreFusion`, verify the cluster version before proceeding:

  • $rankFusion requires MongoDB 8.0+
  • $scoreFusion requires MongoDB 8.2+

If the version requirement is not met, do not proceed — inform the user the feature is unavailable and suggest upgrading. Do not consult references/hybrid-search.md.

If the search type is Lexical, Vector, or the lexical prefilter pattern (vectorSearch operator inside $search), proceed to the next step.

4. Consult Reference Files

Always consult the appropriate reference file(s) before recommending indexes or queries:

  • Lexical: consult both references/lexical-search-indexing.md (index) and references/lexical-search-querying.md (query)
  • Vector: consult references/vector-search.md
  • Hybrid: consult references/hybrid-search.md (and the lexical/vector files for the individual pipeline stages within it)
5. Execution and Validation

Creating indexes:

  1. Explain the index configuration in plain language
  2. Show the JSON structure
  3. Ask what the user wants to name the index
  4. Get explicit approval: "Should I create this index?"
  5. Use MCP's create-index tool after approval
  6. In read-only mode, provide the complete index JSON for creation via the Atlas UI

Running queries:

  1. Show the aggregation pipeline
  2. Execute using MCP's aggregate tool
  3. Present results clearly

Refining existing queries:

  1. Ask the user to share their current query
  2. Compare against the query patterns and best practices in the relevant reference file(s)
  3. Propose specific improvements with before/after examples
  4. Run the revised query with aggregate to validate the results
Anti-Patterns to Avoid

NEVER recommend $regex or $text for search use cases:

  • $regex: Not designed for full-text search. Lacks relevance scoring, fuzzy matching, and language-aware tokenization.
  • $text: Legacy operator that doesn't scale well for search workloads.

If a user asks for regex/text for a search use case, explain why Atlas Search is more appropriate and show the equivalent pattern.

Handling Edge Cases

User mentions fields you can't find:

  • Use collection-schema to inspect available fields
  • Suggest alternatives or ask for clarification

Required field doesn't exist:

  • Explain what needs to be added and how (e.g., embedding field for vector search)

Query fails or index missing:

  • Use collection-indexes to verify index exists
  • If missing, explain index needs to be created first

Multiple collections are relevant:

  • List options and ask which one they mean
  • If context makes it obvious, confirm your assumption
Remember
  • Always check existing indexes before recommending new ones
  • Explain technical concepts in accessible language
  • Require approval before creating indexes
  • Map user's business requirements to technical implementations
  • Use the appropriate search type for the use case
Install

Skill: OpenSearch Launchpad

by OpenSearch Project

Featured

Take an OpenSearch search application from requirements to a running cluster — BM25, dense and sparse vectors, hybrid retrieval, agentic search and RAG, with relevance evaluation built in.

Browse all skills →