mirror of
https://github.com/meilisearch/meilisearch.git
synced 2025-07-17 20:00:58 +00:00
Compare commits
30 Commits
latest
...
feat/mcp-s
Author | SHA1 | Date | |
---|---|---|---|
3b18cddf57 | |||
8cf31dfc38 | |||
e5192f3bcf | |||
97aeb6db4d | |||
f888f87635 | |||
c5ae43cac6 | |||
8047cfe438 | |||
5717e5c1af | |||
bb07038c31 | |||
d1a088ea0b | |||
b68e22c0e6 | |||
03a36f116e | |||
8a0bf24ed5 | |||
e2763471e5 | |||
b2f2c5d69f | |||
1594c54e23 | |||
13b607bd68 | |||
3d130d31c8 | |||
4cda584b0c | |||
248c90bad5 | |||
0e9040e605 | |||
3e3c00f44c | |||
d986a3bbaf | |||
c2ceb8e41b | |||
3fbe1df770 | |||
150d1db86b | |||
677e8b122c | |||
c8939944c6 | |||
4e6252fb03 | |||
8bd8e744f3 |
169
CLAUDE.md
Normal file
169
CLAUDE.md
Normal file
@ -0,0 +1,169 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Repository Overview
|
||||
|
||||
Meilisearch is a lightning-fast search engine written in Rust. It's organized as a Rust workspace with multiple crates that handle different aspects of the search engine functionality.
|
||||
|
||||
## Architecture
|
||||
|
||||
### Core Crates Structure
|
||||
|
||||
- **`crates/meilisearch/`** - Main HTTP server implementing the REST API with Actix Web
|
||||
- **`crates/milli/`** - Core search engine library (indexing, search algorithms, ranking)
|
||||
- **`crates/index-scheduler/`** - Task scheduling, batching, and index lifecycle management
|
||||
- **`crates/meilisearch-auth/`** - Authentication and API key management
|
||||
- **`crates/meilisearch-types/`** - Shared types and data structures
|
||||
- **`crates/dump/`** - Database dump and restore functionality
|
||||
- **`crates/meilitool/`** - CLI tool for maintenance operations
|
||||
|
||||
### Key Architectural Patterns
|
||||
|
||||
1. **Data Flow**:
|
||||
- Write: HTTP Request → Task Creation → Index Scheduler → Milli Engine → LMDB Storage
|
||||
- Read: HTTP Request → Search Queue → Milli Engine → Response
|
||||
|
||||
2. **Concurrency Model**:
|
||||
- Single writer, multiple readers for index operations
|
||||
- Task batching for improved throughput
|
||||
- Search queue for managing concurrent requests
|
||||
|
||||
3. **Storage**: LMDB (Lightning Memory-Mapped Database) with separate environments for tasks, auth, and indexes
|
||||
|
||||
## Development Commands
|
||||
|
||||
### Building and Running
|
||||
|
||||
```bash
|
||||
# Development
|
||||
cargo run
|
||||
|
||||
# Production build with optimizations
|
||||
cargo run --release
|
||||
|
||||
# Build specific crates
|
||||
cargo build --release -p meilisearch -p meilitool
|
||||
|
||||
# Build without default features
|
||||
cargo build --locked --release --no-default-features --all
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
cargo test
|
||||
|
||||
# Run tests with release optimizations
|
||||
cargo test --locked --release --all
|
||||
|
||||
# Run a specific test
|
||||
cargo test test_name
|
||||
|
||||
# Run tests in a specific crate
|
||||
cargo test -p milli
|
||||
```
|
||||
|
||||
### Benchmarking
|
||||
|
||||
```bash
|
||||
# List available features
|
||||
cargo xtask list-features
|
||||
|
||||
# Run workload-based benchmarks
|
||||
cargo xtask bench -- workloads/hackernews.json
|
||||
|
||||
# Run benchmarks without dashboard
|
||||
cargo xtask bench --no-dashboard -- workloads/hackernews.json
|
||||
|
||||
# Run criterion benchmarks
|
||||
cd crates/benchmarks && cargo bench
|
||||
```
|
||||
|
||||
### Performance Optimizations
|
||||
|
||||
```bash
|
||||
# Speed up builds with lindera cache
|
||||
export LINDERA_CACHE=$HOME/.cache/lindera
|
||||
|
||||
# Prevent rebuilds on directory changes (development only)
|
||||
export MEILI_NO_VERGEN=1
|
||||
|
||||
# Enable full snapshot creation for debugging tests
|
||||
export MEILI_TEST_FULL_SNAPS=true
|
||||
```
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
- **Unit tests**: Colocated with source code using `#[cfg(test)]` modules
|
||||
- **Integration tests**: Located in `crates/meilisearch/tests/`
|
||||
- **Snapshot testing**: Using `insta` for deterministic testing
|
||||
- **Test organization**: By feature (auth, documents, search, settings, index operations)
|
||||
|
||||
## Important Files and Directories
|
||||
|
||||
- `Cargo.toml` - Workspace configuration
|
||||
- `rust-toolchain.toml` - Rust version (1.85.1)
|
||||
- `crates/meilisearch/src/main.rs` - Server entry point
|
||||
- `crates/milli/src/lib.rs` - Core engine entry point
|
||||
- `crates/meilisearch-mcp/` - MCP server implementation
|
||||
- `workloads/` - Benchmark workload definitions
|
||||
- `assets/` - Static assets and demo files
|
||||
|
||||
## Feature Flags
|
||||
|
||||
Key features that can be enabled/disabled:
|
||||
- Language-specific tokenizations (chinese, hebrew, japanese, thai, greek, khmer, vietnamese)
|
||||
- `mini-dashboard` - Web UI for testing
|
||||
- `metrics` - Prometheus metrics
|
||||
- `vector-hnsw` - Vector search with CUDA support
|
||||
- `mcp` - Model Context Protocol server for AI assistants
|
||||
|
||||
## Logging and Profiling
|
||||
|
||||
The codebase uses `tracing` for structured logging with these conventions:
|
||||
- Regular logging spans
|
||||
- Profiling spans (TRACE level, prefixed with `indexing::` or `search::`)
|
||||
- Benchmarking spans
|
||||
|
||||
For indexing profiling, enable the `exportPuffinReports` experimental feature to generate `.puffin` files.
|
||||
|
||||
## Common Development Tasks
|
||||
|
||||
### Adding a New Route
|
||||
1. Add route handler in `crates/meilisearch/src/routes/`
|
||||
2. Update OpenAPI documentation if API changes
|
||||
3. Add integration tests in `crates/meilisearch/tests/`
|
||||
4. If MCP is enabled, routes are automatically exposed via MCP
|
||||
|
||||
### Modifying Index Operations
|
||||
1. Core logic lives in `crates/milli/src/update/`
|
||||
2. Task scheduling in `crates/index-scheduler/src/`
|
||||
3. HTTP handlers in `crates/meilisearch/src/routes/indexes/`
|
||||
|
||||
### Working with Search
|
||||
1. Search algorithms in `crates/milli/src/search/`
|
||||
2. Query parsing in `crates/filter-parser/`
|
||||
3. Search handlers in `crates/meilisearch/src/routes/indexes/search.rs`
|
||||
|
||||
### Working with MCP Server
|
||||
1. MCP implementation in `crates/meilisearch-mcp/`
|
||||
2. Tools are auto-generated from OpenAPI specification
|
||||
3. Enable with `--features mcp` flag
|
||||
4. Access via `/mcp` endpoint (SSE or POST)
|
||||
|
||||
## CI/CD and Git Workflow
|
||||
|
||||
- Main branch: `main`
|
||||
- GitHub Merge Queue enforces rebasing and test passing
|
||||
- Benchmarks run automatically on push to `main`
|
||||
- Manual benchmark runs: comment `/bench workloads/*.json` on PRs
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Key environment variables for development:
|
||||
- `MEILI_NO_ANALYTICS` - Disable telemetry
|
||||
- `MEILI_DB_PATH` - Database storage location
|
||||
- `MEILI_HTTP_ADDR` - Server binding address
|
||||
- `MEILI_MASTER_KEY` - Master API key for authentication
|
230
Cargo.lock
generated
230
Cargo.lock
generated
@ -71,6 +71,7 @@ dependencies = [
|
||||
"tokio",
|
||||
"tokio-util",
|
||||
"tracing",
|
||||
"zstd",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@ -92,6 +93,7 @@ dependencies = [
|
||||
"bytestring",
|
||||
"cfg-if",
|
||||
"http 0.2.11",
|
||||
"regex",
|
||||
"regex-lite",
|
||||
"serde",
|
||||
"tracing",
|
||||
@ -198,6 +200,7 @@ dependencies = [
|
||||
"mime",
|
||||
"once_cell",
|
||||
"pin-project-lite",
|
||||
"regex",
|
||||
"regex-lite",
|
||||
"serde",
|
||||
"serde_json",
|
||||
@ -423,6 +426,28 @@ dependencies = [
|
||||
"serde_json",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-stream"
|
||||
version = "0.3.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0b5a71a6f37880a80d1d7f19efd781e4b5de42c88f0722cc13bcb6cc2cfe8476"
|
||||
dependencies = [
|
||||
"async-stream-impl",
|
||||
"futures-core",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-stream-impl"
|
||||
version = "0.3.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c7c24de15d275a1ecfd47a380fb4d5ec9bfe0933f309ed5e705b775596a3574d"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 2.0.87",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-trait"
|
||||
version = "0.1.85"
|
||||
@ -1178,6 +1203,16 @@ dependencies = [
|
||||
"version_check",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "core-foundation"
|
||||
version = "0.9.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "91e195e091a93c46f7102ec7818a2aa394e1e1771c3ab4825963fa03e45afb8f"
|
||||
dependencies = [
|
||||
"core-foundation-sys",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "core-foundation-sys"
|
||||
version = "0.8.7"
|
||||
@ -1923,6 +1958,21 @@ version = "0.1.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f81ec6369c545a7d40e4589b5597581fa1c441fe1cce96dd1de43159910a36a2"
|
||||
|
||||
[[package]]
|
||||
name = "foreign-types"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1"
|
||||
dependencies = [
|
||||
"foreign-types-shared",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "foreign-types-shared"
|
||||
version = "0.1.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b"
|
||||
|
||||
[[package]]
|
||||
name = "form_urlencoded"
|
||||
version = "1.2.1"
|
||||
@ -2566,6 +2616,22 @@ dependencies = [
|
||||
"webpki-roots",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hyper-tls"
|
||||
version = "0.6.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "70206fc6890eaca9fde8a0bf71caa2ddfc9fe045ac9e5c70df101a7dbde866e0"
|
||||
dependencies = [
|
||||
"bytes",
|
||||
"http-body-util",
|
||||
"hyper",
|
||||
"hyper-util",
|
||||
"native-tls",
|
||||
"tokio",
|
||||
"tokio-native-tls",
|
||||
"tower-service",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hyper-util"
|
||||
version = "0.1.10"
|
||||
@ -3632,6 +3698,7 @@ dependencies = [
|
||||
"maplit",
|
||||
"meili-snap",
|
||||
"meilisearch-auth",
|
||||
"meilisearch-mcp",
|
||||
"meilisearch-types",
|
||||
"mimalloc",
|
||||
"mime",
|
||||
@ -3704,6 +3771,30 @@ dependencies = [
|
||||
"uuid",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "meilisearch-mcp"
|
||||
version = "1.13.0"
|
||||
dependencies = [
|
||||
"actix-rt",
|
||||
"actix-web",
|
||||
"anyhow",
|
||||
"async-stream",
|
||||
"async-trait",
|
||||
"futures",
|
||||
"insta",
|
||||
"meilisearch-auth",
|
||||
"meilisearch-types",
|
||||
"regex",
|
||||
"reqwest",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"thiserror 1.0.69",
|
||||
"tokio",
|
||||
"tracing",
|
||||
"utoipa",
|
||||
"uuid",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "meilisearch-types"
|
||||
version = "1.15.0"
|
||||
@ -3956,6 +4047,23 @@ version = "0.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e94e1e6445d314f972ff7395df2de295fe51b71821694f0b0e1e79c4f12c8577"
|
||||
|
||||
[[package]]
|
||||
name = "native-tls"
|
||||
version = "0.2.14"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "87de3442987e9dbec73158d5c715e7ad9072fda936bb03d19d7fa10e00520f0e"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"log",
|
||||
"openssl",
|
||||
"openssl-probe",
|
||||
"openssl-sys",
|
||||
"schannel",
|
||||
"security-framework",
|
||||
"security-framework-sys",
|
||||
"tempfile",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "nohash"
|
||||
version = "0.2.0"
|
||||
@ -4178,6 +4286,50 @@ version = "11.1.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0ab1bc2a289d34bd04a330323ac98a1b4bc82c9d9fcb1e66b63caa84da26b575"
|
||||
|
||||
[[package]]
|
||||
name = "openssl"
|
||||
version = "0.10.72"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "fedfea7d58a1f73118430a55da6a286e7b044961736ce96a16a17068ea25e5da"
|
||||
dependencies = [
|
||||
"bitflags 2.9.0",
|
||||
"cfg-if",
|
||||
"foreign-types",
|
||||
"libc",
|
||||
"once_cell",
|
||||
"openssl-macros",
|
||||
"openssl-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "openssl-macros"
|
||||
version = "0.1.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 2.0.87",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "openssl-probe"
|
||||
version = "0.1.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d05e27ee213611ffe7d6348b942e8f942b37114c00cc03cec254295a4a17852e"
|
||||
|
||||
[[package]]
|
||||
name = "openssl-sys"
|
||||
version = "0.9.108"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e145e1651e858e820e4860f7b9c5e169bc1d8ce1c86043be79fa7b7634821847"
|
||||
dependencies = [
|
||||
"cc",
|
||||
"libc",
|
||||
"pkg-config",
|
||||
"vcpkg",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "option-ext"
|
||||
version = "0.2.0"
|
||||
@ -4858,19 +5010,23 @@ checksum = "43e734407157c3c2034e0258f5e4473ddb361b1e85f95a66690d67264d7cd1da"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"bytes",
|
||||
"encoding_rs",
|
||||
"futures-channel",
|
||||
"futures-core",
|
||||
"futures-util",
|
||||
"h2 0.4.5",
|
||||
"http 1.2.0",
|
||||
"http-body",
|
||||
"http-body-util",
|
||||
"hyper",
|
||||
"hyper-rustls",
|
||||
"hyper-tls",
|
||||
"hyper-util",
|
||||
"ipnet",
|
||||
"js-sys",
|
||||
"log",
|
||||
"mime",
|
||||
"native-tls",
|
||||
"once_cell",
|
||||
"percent-encoding",
|
||||
"pin-project-lite",
|
||||
@ -4882,7 +5038,9 @@ dependencies = [
|
||||
"serde_json",
|
||||
"serde_urlencoded",
|
||||
"sync_wrapper",
|
||||
"system-configuration",
|
||||
"tokio",
|
||||
"tokio-native-tls",
|
||||
"tokio-rustls",
|
||||
"tokio-util",
|
||||
"tower",
|
||||
@ -5117,6 +5275,15 @@ dependencies = [
|
||||
"winapi-util",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "schannel"
|
||||
version = "0.1.27"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1f29ebaa345f945cec9fbbc532eb307f0fdad8161f281b6369539c8d84876b3d"
|
||||
dependencies = [
|
||||
"windows-sys 0.59.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "scopeguard"
|
||||
version = "1.2.0"
|
||||
@ -5129,6 +5296,29 @@ version = "4.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1c107b6f4780854c8b126e228ea8869f4d7b71260f962fefb57b996b8959ba6b"
|
||||
|
||||
[[package]]
|
||||
name = "security-framework"
|
||||
version = "2.11.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "897b2245f0b511c87893af39b033e5ca9cce68824c4d7e7630b5a1d339658d02"
|
||||
dependencies = [
|
||||
"bitflags 2.9.0",
|
||||
"core-foundation",
|
||||
"core-foundation-sys",
|
||||
"libc",
|
||||
"security-framework-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "security-framework-sys"
|
||||
version = "2.14.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "49db231d56a190491cb4aeda9527f1ad45345af50b0851622a7adb8c03b01c32"
|
||||
dependencies = [
|
||||
"core-foundation-sys",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "segment"
|
||||
version = "0.2.5"
|
||||
@ -5581,6 +5771,27 @@ dependencies = [
|
||||
"windows",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "system-configuration"
|
||||
version = "0.6.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3c879d448e9d986b661742763247d3693ed13609438cf3d006f51f5368a5ba6b"
|
||||
dependencies = [
|
||||
"bitflags 2.9.0",
|
||||
"core-foundation",
|
||||
"system-configuration-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "system-configuration-sys"
|
||||
version = "0.6.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8e1d1b10ced5ca923a1fcb8d03e96b8d3268065d724548c0211415ff6ac6bac4"
|
||||
dependencies = [
|
||||
"core-foundation-sys",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tap"
|
||||
version = "1.0.1"
|
||||
@ -5841,6 +6052,16 @@ dependencies = [
|
||||
"syn 2.0.87",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tokio-native-tls"
|
||||
version = "0.3.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "bbae76ab933c85776efabc971569dd6119c580d8f5d448769dec1764bf796ef2"
|
||||
dependencies = [
|
||||
"native-tls",
|
||||
"tokio",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tokio-rustls"
|
||||
version = "0.26.0"
|
||||
@ -6635,6 +6856,15 @@ dependencies = [
|
||||
"windows-targets 0.52.6",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.59.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
|
||||
dependencies = [
|
||||
"windows-targets 0.52.6",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-targets"
|
||||
version = "0.42.2"
|
||||
|
@ -5,6 +5,7 @@ members = [
|
||||
"crates/meilitool",
|
||||
"crates/meilisearch-types",
|
||||
"crates/meilisearch-auth",
|
||||
"crates/meilisearch-mcp",
|
||||
"crates/meili-snap",
|
||||
"crates/index-scheduler",
|
||||
"crates/dump",
|
||||
|
47
README.md
47
README.md
@ -89,6 +89,53 @@ We also offer a wide range of dedicated guides to all Meilisearch features, such
|
||||
|
||||
Finally, for more in-depth information, refer to our articles explaining fundamental Meilisearch concepts such as [documents](https://www.meilisearch.com/docs/learn/core_concepts/documents?utm_campaign=oss&utm_source=github&utm_medium=meilisearch&utm_content=advanced) and [indexes](https://www.meilisearch.com/docs/learn/core_concepts/indexes?utm_campaign=oss&utm_source=github&utm_medium=meilisearch&utm_content=advanced).
|
||||
|
||||
## 🤖 MCP (Model Context Protocol) Server
|
||||
|
||||
Meilisearch now supports the [Model Context Protocol](https://modelcontextprotocol.io/), allowing AI assistants and LLM applications to directly interact with your search engine.
|
||||
|
||||
### Enabling MCP Server
|
||||
|
||||
To enable the MCP server, compile Meilisearch with the `mcp` feature:
|
||||
|
||||
```bash
|
||||
cargo build --release --features mcp
|
||||
```
|
||||
|
||||
The MCP server will be available at `/mcp` endpoint, supporting both SSE (Server-Sent Events) and regular HTTP POST requests.
|
||||
|
||||
### Features
|
||||
|
||||
- **Automatic Tool Discovery**: All Meilisearch API endpoints are automatically exposed as MCP tools
|
||||
- **Full API Coverage**: Search, index management, document operations, and more
|
||||
- **Authentication Support**: Works with existing Meilisearch API keys
|
||||
- **Streaming Support**: Long-running operations can stream progress updates
|
||||
|
||||
### Example Usage
|
||||
|
||||
AI assistants can discover available tools:
|
||||
```json
|
||||
{
|
||||
"method": "tools/list"
|
||||
}
|
||||
```
|
||||
|
||||
And call Meilisearch operations:
|
||||
```json
|
||||
{
|
||||
"method": "tools/call",
|
||||
"params": {
|
||||
"name": "searchDocuments",
|
||||
"arguments": {
|
||||
"indexUid": "movies",
|
||||
"q": "science fiction",
|
||||
"limit": 10
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For more details on MCP integration, see the [MCP documentation](crates/meilisearch-mcp/README.md).
|
||||
|
||||
## 📊 Telemetry
|
||||
|
||||
Meilisearch collects **anonymized** user data to help us improve our product. You can [deactivate this](https://www.meilisearch.com/docs/learn/what_is_meilisearch/telemetry?utm_campaign=oss&utm_source=github&utm_medium=meilisearch&utm_content=telemetry#how-to-disable-data-collection) whenever you want.
|
||||
|
34
crates/meilisearch-mcp/Cargo.toml
Normal file
34
crates/meilisearch-mcp/Cargo.toml
Normal file
@ -0,0 +1,34 @@
|
||||
[package]
|
||||
name = "meilisearch-mcp"
|
||||
version = "1.13.0"
|
||||
authors = ["Clément Renault <clement@meilisearch.com>"]
|
||||
description = "MCP (Model Context Protocol) server for Meilisearch"
|
||||
homepage = "https://www.meilisearch.com"
|
||||
readme = "README.md"
|
||||
edition = "2021"
|
||||
license = "MIT"
|
||||
|
||||
[dependencies]
|
||||
actix-web = { version = "4.8.0", default-features = false }
|
||||
anyhow = "1.0.86"
|
||||
async-stream = "0.3.5"
|
||||
async-trait = "0.1.81"
|
||||
futures = "0.3.30"
|
||||
# Removed meilisearch dependency to avoid cyclic dependency
|
||||
meilisearch-auth = { path = "../meilisearch-auth" }
|
||||
meilisearch-types = { path = "../meilisearch-types" }
|
||||
serde = { version = "1.0.204", features = ["derive"] }
|
||||
serde_json = { version = "1.0.120", features = ["preserve_order"] }
|
||||
thiserror = "1.0.61"
|
||||
tokio = { version = "1.38.0", features = ["full"] }
|
||||
tracing = "0.1.40"
|
||||
utoipa = { version = "5.3.1", features = ["actix_extras", "time"] }
|
||||
uuid = { version = "1.10.0", features = ["serde", "v4"] }
|
||||
regex = "1.10.2"
|
||||
reqwest = { version = "0.12.5", features = ["json"] }
|
||||
|
||||
[dev-dependencies]
|
||||
insta = "1.39.0"
|
||||
tokio = { version = "1.38.0", features = ["test-util"] }
|
||||
actix-web = { version = "4.8.0", features = ["macros"] }
|
||||
actix-rt = "2.10.0"
|
159
crates/meilisearch-mcp/README.md
Normal file
159
crates/meilisearch-mcp/README.md
Normal file
@ -0,0 +1,159 @@
|
||||
# Meilisearch MCP Server
|
||||
|
||||
This crate implements a Model Context Protocol (MCP) server for Meilisearch, enabling AI assistants and LLM applications to interact with Meilisearch through a standardized protocol.
|
||||
|
||||
## Overview
|
||||
|
||||
The MCP server automatically exposes all Meilisearch HTTP API endpoints as MCP tools, allowing AI assistants to:
|
||||
- Search documents
|
||||
- Manage indexes
|
||||
- Add, update, or delete documents
|
||||
- Configure settings
|
||||
- Monitor tasks
|
||||
- And more...
|
||||
|
||||
## Architecture
|
||||
|
||||
### Dynamic Tool Generation
|
||||
|
||||
The server dynamically generates MCP tools from Meilisearch's OpenAPI specification. This ensures:
|
||||
- Complete API coverage
|
||||
- Automatic updates when new endpoints are added
|
||||
- Consistent parameter validation
|
||||
- Type-safe operations
|
||||
|
||||
### Components
|
||||
|
||||
1. **Protocol Module** (`protocol.rs`): Defines MCP protocol types and messages
|
||||
2. **Registry Module** (`registry.rs`): Converts OpenAPI specs to MCP tools
|
||||
3. **Server Module** (`server.rs`): Handles MCP requests and SSE communication
|
||||
4. **Integration Module** (`integration.rs`): Connects with the main Meilisearch server
|
||||
|
||||
## Usage
|
||||
|
||||
### Enabling the MCP Server
|
||||
|
||||
The MCP server is an optional feature. To enable it:
|
||||
|
||||
```bash
|
||||
cargo build --release --features mcp
|
||||
```
|
||||
|
||||
### Accessing the MCP Server
|
||||
|
||||
Once enabled, the MCP server is available at:
|
||||
- SSE endpoint: `GET /mcp`
|
||||
- HTTP endpoint: `POST /mcp`
|
||||
|
||||
### Authentication
|
||||
|
||||
The MCP server integrates with Meilisearch's existing authentication:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "tools/call",
|
||||
"params": {
|
||||
"name": "searchDocuments",
|
||||
"arguments": {
|
||||
"_auth": {
|
||||
"apiKey": "your-api-key"
|
||||
},
|
||||
"indexUid": "movies",
|
||||
"q": "search query"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Protocol Flow
|
||||
|
||||
1. **Initialize**: Client establishes connection and negotiates protocol version
|
||||
2. **List Tools**: Client discovers available Meilisearch operations
|
||||
3. **Call Tools**: Client executes Meilisearch operations through MCP tools
|
||||
4. **Stream Results**: Server streams responses, especially for long-running operations
|
||||
|
||||
## Example Interactions
|
||||
|
||||
### Initialize Connection
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "initialize",
|
||||
"params": {
|
||||
"protocol_version": "2024-11-05",
|
||||
"capabilities": {},
|
||||
"client_info": {
|
||||
"name": "my-ai-assistant",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### List Available Tools
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "tools/list"
|
||||
}
|
||||
```
|
||||
|
||||
Response includes tools like:
|
||||
- `searchDocuments` - Search within an index
|
||||
- `createIndex` - Create a new index
|
||||
- `addDocuments` - Add documents to an index
|
||||
- `getTask` - Check task status
|
||||
- And many more...
|
||||
|
||||
### Search Documents
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "tools/call",
|
||||
"params": {
|
||||
"name": "searchDocuments",
|
||||
"arguments": {
|
||||
"indexUid": "products",
|
||||
"q": "laptop",
|
||||
"filter": "price < 1000",
|
||||
"limit": 20,
|
||||
"attributesToRetrieve": ["name", "price", "description"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
The crate includes comprehensive tests:
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
cargo test -p meilisearch-mcp
|
||||
|
||||
# Run specific test categories
|
||||
cargo test -p meilisearch-mcp conversion_tests
|
||||
cargo test -p meilisearch-mcp integration_tests
|
||||
cargo test -p meilisearch-mcp e2e_tests
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### Adding New Features
|
||||
|
||||
Since tools are generated dynamically from the OpenAPI specification, new Meilisearch endpoints are automatically available through MCP without code changes.
|
||||
|
||||
### Customizing Tool Names
|
||||
|
||||
Tool names are generated automatically from endpoint paths and HTTP methods. The naming convention:
|
||||
- `GET /indexes` → `getIndexes`
|
||||
- `POST /indexes/{index_uid}/search` → `searchDocuments`
|
||||
- `DELETE /indexes/{index_uid}` → `deleteIndex`
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
- WebSocket support for bidirectional communication
|
||||
- Tool result caching
|
||||
- Batch operations
|
||||
- Custom tool aliases
|
||||
- Rate limiting per MCP client
|
358
crates/meilisearch-mcp/src/conversion_tests.rs
Normal file
358
crates/meilisearch-mcp/src/conversion_tests.rs
Normal file
@ -0,0 +1,358 @@
|
||||
use crate::registry::{McpTool, McpToolRegistry};
|
||||
use serde_json::json;
|
||||
use utoipa::openapi::{OpenApi, PathItem};
|
||||
|
||||
#[test]
|
||||
fn test_convert_simple_get_endpoint() {
|
||||
let tool = McpTool::from_openapi_path(
|
||||
"/indexes/{index_uid}",
|
||||
"GET",
|
||||
&create_mock_path_item_get(),
|
||||
);
|
||||
|
||||
assert_eq!(tool.name, "getIndex");
|
||||
assert_eq!(tool.description, "Get information about an index");
|
||||
assert_eq!(tool.http_method, "GET");
|
||||
assert_eq!(tool.path_template, "/indexes/{index_uid}");
|
||||
|
||||
let schema = &tool.input_schema;
|
||||
assert_eq!(schema["type"], "object");
|
||||
assert_eq!(schema["required"], json!(["indexUid"]));
|
||||
assert_eq!(schema["properties"]["indexUid"]["type"], "string");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_convert_search_endpoint_with_query_params() {
|
||||
let tool = McpTool::from_openapi_path(
|
||||
"/indexes/{index_uid}/search",
|
||||
"POST",
|
||||
&create_mock_search_path_item(),
|
||||
);
|
||||
|
||||
assert_eq!(tool.name, "searchDocuments");
|
||||
assert_eq!(tool.description, "Search for documents in an index");
|
||||
assert_eq!(tool.http_method, "POST");
|
||||
|
||||
let schema = &tool.input_schema;
|
||||
assert_eq!(schema["type"], "object");
|
||||
assert_eq!(schema["required"], json!(["indexUid"]));
|
||||
assert!(schema["properties"]["q"].is_object());
|
||||
assert!(schema["properties"]["limit"].is_object());
|
||||
assert!(schema["properties"]["offset"].is_object());
|
||||
assert!(schema["properties"]["filter"].is_object());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_convert_document_addition_endpoint() {
|
||||
let tool = McpTool::from_openapi_path(
|
||||
"/indexes/{index_uid}/documents",
|
||||
"POST",
|
||||
&create_mock_add_documents_path_item(),
|
||||
);
|
||||
|
||||
assert_eq!(tool.name, "addDocuments");
|
||||
assert_eq!(tool.description, "Add or replace documents in an index");
|
||||
assert_eq!(tool.http_method, "POST");
|
||||
|
||||
let schema = &tool.input_schema;
|
||||
assert_eq!(schema["type"], "object");
|
||||
assert_eq!(schema["required"], json!(["indexUid", "documents"]));
|
||||
assert_eq!(schema["properties"]["documents"]["type"], "array");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_registry_deduplication() {
|
||||
let mut registry = McpToolRegistry::new();
|
||||
|
||||
let tool1 = McpTool {
|
||||
name: "searchDocuments".to_string(),
|
||||
description: "Search documents".to_string(),
|
||||
input_schema: json!({}),
|
||||
http_method: "POST".to_string(),
|
||||
path_template: "/indexes/{index_uid}/search".to_string(),
|
||||
};
|
||||
|
||||
let tool2 = McpTool {
|
||||
name: "searchDocuments".to_string(),
|
||||
description: "Updated description".to_string(),
|
||||
input_schema: json!({"updated": true}),
|
||||
http_method: "POST".to_string(),
|
||||
path_template: "/indexes/{index_uid}/search".to_string(),
|
||||
};
|
||||
|
||||
registry.register_tool(tool1);
|
||||
registry.register_tool(tool2);
|
||||
|
||||
assert_eq!(registry.list_tools().len(), 1);
|
||||
assert_eq!(registry.get_tool("searchDocuments").unwrap().description, "Updated description");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_openapi_to_mcp_tool_conversion() {
|
||||
let openapi = create_mock_openapi();
|
||||
let registry = McpToolRegistry::from_openapi(&openapi);
|
||||
|
||||
let tools = registry.list_tools();
|
||||
assert!(tools.len() > 0);
|
||||
|
||||
let search_tool = registry.get_tool("searchDocuments");
|
||||
assert!(search_tool.is_some());
|
||||
|
||||
let index_tool = registry.get_tool("getIndex");
|
||||
assert!(index_tool.is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_tool_name_generation() {
|
||||
let test_cases = vec![
|
||||
("/indexes", "GET", "getIndexes"),
|
||||
("/indexes", "POST", "createIndex"),
|
||||
("/indexes/{index_uid}", "GET", "getIndex"),
|
||||
("/indexes/{index_uid}", "PUT", "updateIndex"),
|
||||
("/indexes/{index_uid}", "DELETE", "deleteIndex"),
|
||||
("/indexes/{index_uid}/documents", "GET", "getDocuments"),
|
||||
("/indexes/{index_uid}/documents", "POST", "addDocuments"),
|
||||
("/indexes/{index_uid}/documents", "DELETE", "deleteDocuments"),
|
||||
("/indexes/{index_uid}/search", "POST", "searchDocuments"),
|
||||
("/indexes/{index_uid}/settings", "GET", "getSettings"),
|
||||
("/indexes/{index_uid}/settings", "PATCH", "updateSettings"),
|
||||
("/tasks", "GET", "getTasks"),
|
||||
("/tasks/{task_uid}", "GET", "getTask"),
|
||||
("/keys", "GET", "getApiKeys"),
|
||||
("/keys", "POST", "createApiKey"),
|
||||
("/multi-search", "POST", "multiSearch"),
|
||||
("/swap-indexes", "POST", "swapIndexes"),
|
||||
];
|
||||
|
||||
for (path, method, expected_name) in test_cases {
|
||||
let name = McpTool::generate_tool_name(path, method);
|
||||
assert_eq!(name, expected_name, "Path: {}, Method: {}", path, method);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_parameter_extraction() {
|
||||
let tool = McpTool::from_openapi_path(
|
||||
"/indexes/{index_uid}/documents/{document_id}",
|
||||
"GET",
|
||||
&create_mock_get_document_path_item(),
|
||||
);
|
||||
|
||||
let schema = &tool.input_schema;
|
||||
assert_eq!(schema["required"], json!(["indexUid", "documentId"]));
|
||||
assert_eq!(schema["properties"]["indexUid"]["type"], "string");
|
||||
assert_eq!(schema["properties"]["documentId"]["type"], "string");
|
||||
}
|
||||
|
||||
fn create_mock_path_item_get() -> PathItem {
|
||||
serde_json::from_value(json!({
|
||||
"get": {
|
||||
"summary": "Get information about an index",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "index_uid",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Index information"
|
||||
}
|
||||
}
|
||||
}
|
||||
}))
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
fn create_mock_search_path_item() -> PathItem {
|
||||
serde_json::from_value(json!({
|
||||
"post": {
|
||||
"summary": "Search for documents in an index",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "index_uid",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"q": {
|
||||
"type": "string",
|
||||
"description": "Search query"
|
||||
},
|
||||
"limit": {
|
||||
"type": "integer",
|
||||
"default": 20
|
||||
},
|
||||
"offset": {
|
||||
"type": "integer",
|
||||
"default": 0
|
||||
},
|
||||
"filter": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Search results"
|
||||
}
|
||||
}
|
||||
}
|
||||
}))
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
fn create_mock_add_documents_path_item() -> PathItem {
|
||||
serde_json::from_value(json!({
|
||||
"post": {
|
||||
"summary": "Add or replace documents in an index",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "index_uid",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Accepted"
|
||||
}
|
||||
}
|
||||
}
|
||||
}))
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
fn create_mock_get_document_path_item() -> PathItem {
|
||||
serde_json::from_value(json!({
|
||||
"get": {
|
||||
"summary": "Get a specific document",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "index_uid",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "document_id",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Document found"
|
||||
}
|
||||
}
|
||||
}
|
||||
}))
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
fn create_mock_openapi() -> OpenApi {
|
||||
serde_json::from_value(json!({
|
||||
"openapi": "3.1.0",
|
||||
"info": {
|
||||
"title": "Meilisearch API",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
"paths": {
|
||||
"/indexes": {
|
||||
"get": {
|
||||
"summary": "List all indexes",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "List of indexes"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create an index",
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Index created"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/indexes/{index_uid}": {
|
||||
"get": {
|
||||
"summary": "Get information about an index",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "index_uid",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Index information"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/indexes/{index_uid}/search": {
|
||||
"post": {
|
||||
"summary": "Search for documents in an index",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "index_uid",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Search results"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}))
|
||||
.unwrap()
|
||||
}
|
285
crates/meilisearch-mcp/src/e2e_tests.rs
Normal file
285
crates/meilisearch-mcp/src/e2e_tests.rs
Normal file
@ -0,0 +1,285 @@
|
||||
use actix_web::{test, web, App};
|
||||
use serde_json::json;
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn test_mcp_server_sse_communication() {
|
||||
let app = test::init_service(
|
||||
App::new()
|
||||
.app_data(web::Data::new(crate::server::McpServer::new(
|
||||
crate::registry::McpToolRegistry::new(),
|
||||
)))
|
||||
.route("/mcp", web::get().to(crate::server::mcp_sse_handler)),
|
||||
)
|
||||
.await;
|
||||
|
||||
let req = test::TestRequest::get()
|
||||
.uri("/mcp")
|
||||
.insert_header(("Accept", "text/event-stream"))
|
||||
.to_request();
|
||||
|
||||
let resp = test::call_service(&app, req).await;
|
||||
assert!(resp.status().is_success());
|
||||
assert_eq!(
|
||||
resp.headers().get("Content-Type").unwrap(),
|
||||
"text/event-stream"
|
||||
);
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn test_mcp_full_workflow() {
|
||||
// This test simulates a complete MCP client-server interaction
|
||||
let registry = create_test_registry();
|
||||
let server = crate::server::McpServer::new(registry);
|
||||
|
||||
// 1. Initialize
|
||||
let init_request = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "initialize".to_string(),
|
||||
params: Some(json!({
|
||||
"protocol_version": "2024-11-05",
|
||||
"capabilities": {},
|
||||
"client_info": {
|
||||
"name": "test-client",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let init_response = server.handle_json_rpc_request(init_request).await;
|
||||
assert!(matches!(init_response, crate::protocol::JsonRpcResponse::Success { .. }));
|
||||
|
||||
// 2. List tools
|
||||
let list_request = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/list".to_string(),
|
||||
params: None,
|
||||
id: json!(2),
|
||||
};
|
||||
let list_response = server.handle_json_rpc_request(list_request).await;
|
||||
|
||||
let tools = match list_response {
|
||||
crate::protocol::JsonRpcResponse::Success { result, .. } => {
|
||||
let list_result: crate::protocol::ListToolsResult = serde_json::from_value(result).unwrap();
|
||||
list_result.tools
|
||||
},
|
||||
_ => panic!("Expected success response"),
|
||||
};
|
||||
|
||||
assert!(!tools.is_empty());
|
||||
|
||||
// 3. Call a tool
|
||||
let call_request = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": tools[0].name.clone(),
|
||||
"arguments": {
|
||||
"indexUid": "test-index"
|
||||
}
|
||||
})),
|
||||
id: json!(3),
|
||||
};
|
||||
|
||||
let call_response = server.handle_json_rpc_request(call_request).await;
|
||||
assert!(matches!(call_response, crate::protocol::JsonRpcResponse::Success { .. }));
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn test_mcp_authentication_integration() {
|
||||
let registry = create_test_registry();
|
||||
let server = crate::server::McpServer::new(registry);
|
||||
|
||||
// Test with valid API key
|
||||
let request_with_auth = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": "getStats",
|
||||
"arguments": {
|
||||
"_auth": {
|
||||
"apiKey": "test-api-key"
|
||||
}
|
||||
}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request_with_auth).await;
|
||||
|
||||
// Depending on auth implementation, this should either succeed or fail appropriately
|
||||
assert!(matches!(response,
|
||||
crate::protocol::JsonRpcResponse::Success { .. } |
|
||||
crate::protocol::JsonRpcResponse::Error { .. }
|
||||
));
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn test_mcp_tool_execution_with_params() {
|
||||
let registry = create_test_registry();
|
||||
let server = crate::server::McpServer::new(registry);
|
||||
|
||||
// Test tool with complex parameters
|
||||
let request = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": "searchDocuments",
|
||||
"arguments": {
|
||||
"indexUid": "products",
|
||||
"q": "laptop",
|
||||
"limit": 10,
|
||||
"offset": 0,
|
||||
"filter": "price > 500",
|
||||
"sort": ["price:asc"],
|
||||
"facets": ["brand", "category"]
|
||||
}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
crate::protocol::JsonRpcResponse::Success { result, .. } => {
|
||||
let call_result: crate::protocol::CallToolResult = serde_json::from_value(result).unwrap();
|
||||
assert!(!call_result.content.is_empty());
|
||||
assert_eq!(call_result.content[0].content_type, "text");
|
||||
// Verify the response contains search-related content
|
||||
assert!(call_result.content[0].text.contains("search") ||
|
||||
call_result.content[0].text.contains("products"));
|
||||
}
|
||||
_ => panic!("Expected success response"),
|
||||
}
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn test_mcp_error_handling() {
|
||||
let registry = create_test_registry();
|
||||
let server = crate::server::McpServer::new(registry);
|
||||
|
||||
// Test with non-existent tool
|
||||
let request = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": "nonExistentTool",
|
||||
"arguments": {}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
crate::protocol::JsonRpcResponse::Error { error, .. } => {
|
||||
assert_eq!(error.code, crate::protocol::METHOD_NOT_FOUND);
|
||||
assert!(error.message.contains("Tool not found"));
|
||||
}
|
||||
_ => panic!("Expected error response"),
|
||||
}
|
||||
|
||||
// Test with invalid parameters
|
||||
let request = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": "searchDocuments",
|
||||
"arguments": {
|
||||
// Missing required indexUid parameter
|
||||
"q": "test"
|
||||
}
|
||||
})),
|
||||
id: json!(2),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
crate::protocol::JsonRpcResponse::Error { error, .. } => {
|
||||
assert_eq!(error.code, crate::protocol::INVALID_PARAMS);
|
||||
assert!(error.message.contains("Invalid parameters") ||
|
||||
error.message.contains("required"));
|
||||
}
|
||||
_ => panic!("Expected error response"),
|
||||
}
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn test_mcp_protocol_version_negotiation() {
|
||||
let server = crate::server::McpServer::new(crate::registry::McpToolRegistry::new());
|
||||
|
||||
// Test with different protocol versions
|
||||
let request = crate::protocol::JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "initialize".to_string(),
|
||||
params: Some(json!({
|
||||
"protocol_version": "2024-01-01", // Old version
|
||||
"capabilities": {},
|
||||
"client_info": {
|
||||
"name": "test-client",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
crate::protocol::JsonRpcResponse::Success { result, .. } => {
|
||||
let init_result: crate::protocol::InitializeResult = serde_json::from_value(result).unwrap();
|
||||
// Server should respond with its supported version
|
||||
assert_eq!(init_result.protocol_version, "2024-11-05");
|
||||
}
|
||||
_ => panic!("Expected success response"),
|
||||
}
|
||||
}
|
||||
|
||||
fn create_test_registry() -> crate::registry::McpToolRegistry {
|
||||
let mut registry = crate::registry::McpToolRegistry::new();
|
||||
|
||||
// Add test tools
|
||||
registry.register_tool(crate::registry::McpTool {
|
||||
name: "getStats".to_string(),
|
||||
description: "Get server statistics".to_string(),
|
||||
input_schema: json!({
|
||||
"type": "object",
|
||||
"properties": {},
|
||||
"required": []
|
||||
}),
|
||||
http_method: "GET".to_string(),
|
||||
path_template: "/stats".to_string(),
|
||||
});
|
||||
|
||||
registry.register_tool(crate::registry::McpTool {
|
||||
name: "searchDocuments".to_string(),
|
||||
description: "Search for documents in an index".to_string(),
|
||||
input_schema: json!({
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"indexUid": {
|
||||
"type": "string",
|
||||
"description": "The index UID"
|
||||
},
|
||||
"q": {
|
||||
"type": "string",
|
||||
"description": "Query string"
|
||||
},
|
||||
"limit": {
|
||||
"type": "integer",
|
||||
"description": "Maximum number of results"
|
||||
},
|
||||
"offset": {
|
||||
"type": "integer",
|
||||
"description": "Number of results to skip"
|
||||
}
|
||||
},
|
||||
"required": ["indexUid"]
|
||||
}),
|
||||
http_method: "POST".to_string(),
|
||||
path_template: "/indexes/{indexUid}/search".to_string(),
|
||||
});
|
||||
|
||||
registry
|
||||
}
|
49
crates/meilisearch-mcp/src/error.rs
Normal file
49
crates/meilisearch-mcp/src/error.rs
Normal file
@ -0,0 +1,49 @@
|
||||
use thiserror::Error;
|
||||
|
||||
#[derive(Debug, Error)]
|
||||
pub enum Error {
|
||||
#[error("Protocol error: {0}")]
|
||||
Protocol(String),
|
||||
|
||||
#[error("Tool not found: {0}")]
|
||||
ToolNotFound(String),
|
||||
|
||||
#[error("Invalid parameters: {0}")]
|
||||
InvalidParameters(String),
|
||||
|
||||
#[error("Authentication failed: {0}")]
|
||||
AuthenticationFailed(String),
|
||||
|
||||
#[error("Internal error: {0}")]
|
||||
Internal(#[from] anyhow::Error),
|
||||
|
||||
#[error("JSON error: {0}")]
|
||||
Json(#[from] serde_json::Error),
|
||||
|
||||
#[error("Meilisearch error: {0}")]
|
||||
Meilisearch(String),
|
||||
}
|
||||
|
||||
impl Error {
|
||||
pub fn to_mcp_error(&self) -> serde_json::Value {
|
||||
serde_json::json!({
|
||||
"jsonrpc": "2.0",
|
||||
"error": {
|
||||
"code": self.error_code(),
|
||||
"message": self.to_string(),
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn error_code(&self) -> i32 {
|
||||
match self {
|
||||
Error::Protocol(_) => -32700,
|
||||
Error::ToolNotFound(_) => -32601,
|
||||
Error::InvalidParameters(_) => -32602,
|
||||
Error::AuthenticationFailed(_) => -32000,
|
||||
Error::Internal(_) => -32603,
|
||||
Error::Json(_) => -32700,
|
||||
Error::Meilisearch(_) => -32000,
|
||||
}
|
||||
}
|
||||
}
|
129
crates/meilisearch-mcp/src/integration.rs
Normal file
129
crates/meilisearch-mcp/src/integration.rs
Normal file
@ -0,0 +1,129 @@
|
||||
use crate::registry::McpToolRegistry;
|
||||
use crate::server::{McpServer, MeilisearchClient};
|
||||
use crate::Error;
|
||||
use actix_web::{web, HttpResponse};
|
||||
use serde_json::Value;
|
||||
use utoipa::openapi::OpenApi;
|
||||
|
||||
pub struct MeilisearchMcpClient {
|
||||
base_url: String,
|
||||
client: reqwest::Client,
|
||||
}
|
||||
|
||||
impl MeilisearchMcpClient {
|
||||
pub fn new(base_url: String) -> Self {
|
||||
Self {
|
||||
base_url,
|
||||
client: reqwest::Client::new(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl MeilisearchClient for MeilisearchMcpClient {
|
||||
async fn call_endpoint(
|
||||
&self,
|
||||
method: &str,
|
||||
path: &str,
|
||||
body: Option<Value>,
|
||||
auth_header: Option<String>,
|
||||
) -> Result<Value, Error> {
|
||||
let url = format!("{}{}", self.base_url, path);
|
||||
let mut request = match method {
|
||||
"GET" => self.client.get(&url),
|
||||
"POST" => self.client.post(&url),
|
||||
"PUT" => self.client.put(&url),
|
||||
"DELETE" => self.client.delete(&url),
|
||||
"PATCH" => self.client.patch(&url),
|
||||
_ => return Err(Error::Protocol(format!("Unsupported method: {}", method))),
|
||||
};
|
||||
|
||||
if let Some(auth) = auth_header {
|
||||
request = request.header("Authorization", auth);
|
||||
}
|
||||
|
||||
if let Some(body) = body {
|
||||
request = request.json(&body);
|
||||
}
|
||||
|
||||
let response = request
|
||||
.send()
|
||||
.await
|
||||
.map_err(|e| Error::Internal(e.into()))?;
|
||||
|
||||
if response.status().is_success() {
|
||||
response
|
||||
.json()
|
||||
.await
|
||||
.map_err(|e| Error::Internal(e.into()))
|
||||
} else {
|
||||
let status = response.status();
|
||||
let error_body = response
|
||||
.text()
|
||||
.await
|
||||
.unwrap_or_else(|_| "Failed to read error response".to_string());
|
||||
|
||||
Err(Error::Meilisearch(format!(
|
||||
"Request failed with status {}: {}",
|
||||
status, error_body
|
||||
)))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub fn create_mcp_server_from_openapi(openapi: OpenApi) -> McpServer {
|
||||
// Create registry from OpenAPI
|
||||
let registry = McpToolRegistry::from_openapi(&openapi);
|
||||
|
||||
// Create MCP server
|
||||
McpServer::new(registry)
|
||||
}
|
||||
|
||||
pub fn configure_mcp_route(cfg: &mut web::ServiceConfig, openapi: OpenApi) {
|
||||
let server = create_mcp_server_from_openapi(openapi);
|
||||
cfg.app_data(web::Data::new(server))
|
||||
.service(
|
||||
web::resource("/mcp")
|
||||
.route(web::get().to(crate::server::mcp_sse_handler))
|
||||
.route(web::post().to(mcp_post_handler))
|
||||
.route(web::method(actix_web::http::Method::OPTIONS).to(mcp_options_handler))
|
||||
);
|
||||
}
|
||||
|
||||
async fn mcp_post_handler(
|
||||
req_body: web::Json<crate::protocol::JsonRpcRequest>,
|
||||
server: web::Data<McpServer>,
|
||||
) -> Result<HttpResponse, actix_web::Error> {
|
||||
let response = server.handle_json_rpc_request(req_body.into_inner()).await;
|
||||
Ok(HttpResponse::Ok()
|
||||
.insert_header(("Access-Control-Allow-Origin", "*"))
|
||||
.insert_header(("Access-Control-Allow-Headers", "*"))
|
||||
.json(response))
|
||||
}
|
||||
|
||||
async fn mcp_options_handler() -> Result<HttpResponse, actix_web::Error> {
|
||||
Ok(HttpResponse::Ok()
|
||||
.insert_header(("Access-Control-Allow-Origin", "*"))
|
||||
.insert_header(("Access-Control-Allow-Methods", "GET, POST, OPTIONS"))
|
||||
.insert_header(("Access-Control-Allow-Headers", "*"))
|
||||
.finish())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use utoipa::openapi::{OpenApiBuilder, InfoBuilder};
|
||||
|
||||
#[test]
|
||||
fn test_create_mcp_server() {
|
||||
let openapi = OpenApiBuilder::new()
|
||||
.info(InfoBuilder::new()
|
||||
.title("Test API")
|
||||
.version("1.0")
|
||||
.build())
|
||||
.build();
|
||||
let _server = create_mcp_server_from_openapi(openapi);
|
||||
// Server should be created successfully
|
||||
assert!(true);
|
||||
}
|
||||
}
|
283
crates/meilisearch-mcp/src/integration_tests.rs
Normal file
283
crates/meilisearch-mcp/src/integration_tests.rs
Normal file
@ -0,0 +1,283 @@
|
||||
use crate::protocol::*;
|
||||
use crate::server::McpServer;
|
||||
use crate::registry::McpToolRegistry;
|
||||
use serde_json::json;
|
||||
use tokio;
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mcp_initialize_request() {
|
||||
let server = McpServer::new(McpToolRegistry::new());
|
||||
|
||||
let request = JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "initialize".to_string(),
|
||||
params: Some(json!({
|
||||
"protocol_version": "2024-11-05",
|
||||
"capabilities": {},
|
||||
"client_info": {
|
||||
"name": "test-client",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
JsonRpcResponse::Success { result, .. } => {
|
||||
let init_result: InitializeResult = serde_json::from_value(result).unwrap();
|
||||
assert_eq!(init_result.protocol_version, "2024-11-05");
|
||||
assert_eq!(init_result.server_info.name, "meilisearch-mcp");
|
||||
assert!(init_result.capabilities.tools.list_changed);
|
||||
}
|
||||
_ => panic!("Expected success response"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mcp_list_tools_request() {
|
||||
let mut registry = McpToolRegistry::new();
|
||||
registry.register_tool(crate::registry::McpTool {
|
||||
name: "searchDocuments".to_string(),
|
||||
description: "Search for documents".to_string(),
|
||||
input_schema: json!({
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"indexUid": { "type": "string" },
|
||||
"q": { "type": "string" }
|
||||
},
|
||||
"required": ["indexUid"]
|
||||
}),
|
||||
http_method: "POST".to_string(),
|
||||
path_template: "/indexes/{index_uid}/search".to_string(),
|
||||
});
|
||||
|
||||
let server = McpServer::new(registry);
|
||||
let request = JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/list".to_string(),
|
||||
params: None,
|
||||
id: json!(2),
|
||||
};
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
JsonRpcResponse::Success { result, .. } => {
|
||||
let list_result: ListToolsResult = serde_json::from_value(result).unwrap();
|
||||
assert_eq!(list_result.tools.len(), 1);
|
||||
assert_eq!(list_result.tools[0].name, "searchDocuments");
|
||||
assert_eq!(list_result.tools[0].description, "Search for documents");
|
||||
assert!(list_result.tools[0].input_schema["type"] == "object");
|
||||
}
|
||||
_ => panic!("Expected success response"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mcp_call_tool_request_success() {
|
||||
let mut registry = McpToolRegistry::new();
|
||||
registry.register_tool(crate::registry::McpTool {
|
||||
name: "getStats".to_string(),
|
||||
description: "Get server statistics".to_string(),
|
||||
input_schema: json!({
|
||||
"type": "object",
|
||||
"properties": {},
|
||||
}),
|
||||
http_method: "GET".to_string(),
|
||||
path_template: "/stats".to_string(),
|
||||
});
|
||||
|
||||
let server = McpServer::new(registry);
|
||||
let request = JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": "getStats",
|
||||
"arguments": {}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
JsonRpcResponse::Success { result, .. } => {
|
||||
let call_result: CallToolResult = serde_json::from_value(result).unwrap();
|
||||
assert!(!call_result.content.is_empty());
|
||||
assert_eq!(call_result.content[0].content_type, "text");
|
||||
assert!(call_result.is_error.is_none() || !call_result.is_error.unwrap());
|
||||
}
|
||||
_ => panic!("Expected success response"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mcp_call_unknown_tool() {
|
||||
let server = McpServer::new(McpToolRegistry::new());
|
||||
let request = JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": "unknownTool",
|
||||
"arguments": {}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
JsonRpcResponse::Error { error, .. } => {
|
||||
assert_eq!(error.code, crate::protocol::METHOD_NOT_FOUND);
|
||||
assert!(error.message.contains("Tool not found"));
|
||||
}
|
||||
_ => panic!("Expected error response"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mcp_call_tool_with_invalid_params() {
|
||||
let mut registry = McpToolRegistry::new();
|
||||
registry.register_tool(crate::registry::McpTool {
|
||||
name: "searchDocuments".to_string(),
|
||||
description: "Search for documents".to_string(),
|
||||
input_schema: json!({
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"indexUid": { "type": "string" },
|
||||
"q": { "type": "string" }
|
||||
},
|
||||
"required": ["indexUid"]
|
||||
}),
|
||||
http_method: "POST".to_string(),
|
||||
path_template: "/indexes/{index_uid}/search".to_string(),
|
||||
});
|
||||
|
||||
let server = McpServer::new(registry);
|
||||
let request = JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "tools/call".to_string(),
|
||||
params: Some(json!({
|
||||
"name": "searchDocuments",
|
||||
"arguments": {} // Missing required indexUid
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
JsonRpcResponse::Error { error, .. } => {
|
||||
assert_eq!(error.code, crate::protocol::INVALID_PARAMS);
|
||||
assert!(error.message.contains("Invalid parameters"));
|
||||
}
|
||||
_ => panic!("Expected error response"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_protocol_version_negotiation() {
|
||||
let server = McpServer::new(McpToolRegistry::new());
|
||||
|
||||
let test_versions = vec![
|
||||
"2024-11-05",
|
||||
"2024-11-01", // Older version
|
||||
"2025-01-01", // Future version
|
||||
];
|
||||
|
||||
for version in test_versions {
|
||||
let request = JsonRpcRequest {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
method: "initialize".to_string(),
|
||||
params: Some(json!({
|
||||
"protocol_version": version,
|
||||
"capabilities": {},
|
||||
"client_info": {
|
||||
"name": "test-client",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
})),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let response = server.handle_json_rpc_request(request).await;
|
||||
|
||||
match response {
|
||||
JsonRpcResponse::Success { result, .. } => {
|
||||
let init_result: InitializeResult = serde_json::from_value(result).unwrap();
|
||||
// Server should always return its supported version
|
||||
assert_eq!(init_result.protocol_version, "2024-11-05");
|
||||
}
|
||||
_ => panic!("Expected success response"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_json_rpc_response_serialization() {
|
||||
let response = JsonRpcResponse::Success {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
result: json!({
|
||||
"protocol_version": "2024-11-05",
|
||||
"capabilities": {
|
||||
"tools": {
|
||||
"list_changed": true
|
||||
},
|
||||
"experimental": {}
|
||||
},
|
||||
"server_info": {
|
||||
"name": "meilisearch-mcp",
|
||||
"version": env!("CARGO_PKG_VERSION")
|
||||
}
|
||||
}),
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let serialized = serde_json::to_string(&response).unwrap();
|
||||
let deserialized: JsonRpcResponse = serde_json::from_str(&serialized).unwrap();
|
||||
|
||||
match deserialized {
|
||||
JsonRpcResponse::Success { result, .. } => {
|
||||
assert_eq!(result["protocol_version"], "2024-11-05");
|
||||
assert_eq!(result["server_info"]["name"], "meilisearch-mcp");
|
||||
}
|
||||
_ => panic!("Deserialization failed"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_tool_result_formatting() {
|
||||
let result = CallToolResult {
|
||||
content: vec![
|
||||
ToolContent {
|
||||
content_type: "text".to_string(),
|
||||
text: "Success: Index created".to_string(),
|
||||
},
|
||||
],
|
||||
is_error: None,
|
||||
};
|
||||
|
||||
let serialized = serde_json::to_string(&result).unwrap();
|
||||
assert!(serialized.contains("\"type\":\"text\""));
|
||||
assert!(serialized.contains("Success: Index created"));
|
||||
assert!(!serialized.contains("is_error"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_error_response_formatting() {
|
||||
let error_response = JsonRpcResponse::Error {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
error: JsonRpcError {
|
||||
code: -32601,
|
||||
message: "Method not found".to_string(),
|
||||
data: Some(json!({ "method": "unknownMethod" })),
|
||||
},
|
||||
id: json!(1),
|
||||
};
|
||||
|
||||
let serialized = serde_json::to_string(&error_response).unwrap();
|
||||
assert!(serialized.contains("\"code\":-32601"));
|
||||
assert!(serialized.contains("Method not found"));
|
||||
assert!(serialized.contains("unknownMethod"));
|
||||
}
|
16
crates/meilisearch-mcp/src/lib.rs
Normal file
16
crates/meilisearch-mcp/src/lib.rs
Normal file
@ -0,0 +1,16 @@
|
||||
pub mod error;
|
||||
pub mod integration;
|
||||
pub mod protocol;
|
||||
pub mod registry;
|
||||
pub mod server;
|
||||
|
||||
#[cfg(test)]
|
||||
mod conversion_tests;
|
||||
#[cfg(test)]
|
||||
mod integration_tests;
|
||||
#[cfg(test)]
|
||||
mod e2e_tests;
|
||||
|
||||
pub use error::Error;
|
||||
pub use registry::McpToolRegistry;
|
||||
pub use server::McpServer;
|
147
crates/meilisearch-mcp/src/protocol.rs
Normal file
147
crates/meilisearch-mcp/src/protocol.rs
Normal file
@ -0,0 +1,147 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::Value;
|
||||
|
||||
// JSON-RPC 2.0 wrapper types
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct JsonRpcRequest {
|
||||
pub jsonrpc: String,
|
||||
pub method: String,
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub params: Option<Value>,
|
||||
pub id: Value,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(untagged)]
|
||||
pub enum JsonRpcResponse {
|
||||
Success {
|
||||
jsonrpc: String,
|
||||
result: Value,
|
||||
id: Value,
|
||||
},
|
||||
Error {
|
||||
jsonrpc: String,
|
||||
error: JsonRpcError,
|
||||
id: Value,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct JsonRpcError {
|
||||
pub code: i32,
|
||||
pub message: String,
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub data: Option<Value>,
|
||||
}
|
||||
|
||||
// MCP-specific request types
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(tag = "method")]
|
||||
pub enum McpRequest {
|
||||
#[serde(rename = "initialize")]
|
||||
Initialize {
|
||||
#[serde(default)]
|
||||
params: InitializeParams,
|
||||
},
|
||||
#[serde(rename = "tools/list")]
|
||||
ListTools,
|
||||
#[serde(rename = "tools/call")]
|
||||
CallTool {
|
||||
params: CallToolParams,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct InitializeParams {
|
||||
pub protocol_version: String,
|
||||
pub capabilities: ClientCapabilities,
|
||||
pub client_info: ClientInfo,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
|
||||
pub struct ClientCapabilities {
|
||||
#[serde(default)]
|
||||
pub experimental: Value,
|
||||
#[serde(default)]
|
||||
pub sampling: Value,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ClientInfo {
|
||||
pub name: String,
|
||||
pub version: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct CallToolParams {
|
||||
pub name: String,
|
||||
#[serde(default)]
|
||||
pub arguments: Value,
|
||||
}
|
||||
|
||||
// Response types are now just the result objects, wrapped in JsonRpcResponse
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct InitializeResult {
|
||||
pub protocol_version: String,
|
||||
pub capabilities: ServerCapabilities,
|
||||
pub server_info: ServerInfo,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct ServerCapabilities {
|
||||
pub tools: ToolsCapability,
|
||||
#[serde(default)]
|
||||
pub experimental: Value,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ToolsCapability {
|
||||
pub list_changed: bool,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ServerInfo {
|
||||
pub name: String,
|
||||
pub version: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct ListToolsResult {
|
||||
pub tools: Vec<Tool>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct Tool {
|
||||
pub name: String,
|
||||
pub description: String,
|
||||
#[serde(rename = "inputSchema")]
|
||||
pub input_schema: Value,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct CallToolResult {
|
||||
pub content: Vec<ToolContent>,
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub is_error: Option<bool>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct ToolContent {
|
||||
#[serde(rename = "type")]
|
||||
pub content_type: String,
|
||||
pub text: String,
|
||||
}
|
||||
|
||||
// Standard JSON-RPC error codes
|
||||
pub const PARSE_ERROR: i32 = -32700;
|
||||
pub const INVALID_REQUEST: i32 = -32600;
|
||||
pub const METHOD_NOT_FOUND: i32 = -32601;
|
||||
pub const INVALID_PARAMS: i32 = -32602;
|
||||
pub const INTERNAL_ERROR: i32 = -32603;
|
381
crates/meilisearch-mcp/src/registry.rs
Normal file
381
crates/meilisearch-mcp/src/registry.rs
Normal file
@ -0,0 +1,381 @@
|
||||
use crate::protocol::Tool;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::{json, Value};
|
||||
use std::collections::HashMap;
|
||||
use utoipa::openapi::{OpenApi, PathItem};
|
||||
use utoipa::openapi::path::Operation;
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct McpTool {
|
||||
pub name: String,
|
||||
pub description: String,
|
||||
#[serde(rename = "inputSchema")]
|
||||
pub input_schema: Value,
|
||||
pub http_method: String,
|
||||
pub path_template: String,
|
||||
}
|
||||
|
||||
pub struct McpToolRegistry {
|
||||
tools: HashMap<String, McpTool>,
|
||||
}
|
||||
|
||||
impl McpToolRegistry {
|
||||
pub fn new() -> Self {
|
||||
Self {
|
||||
tools: HashMap::new(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn from_openapi(openapi: &OpenApi) -> Self {
|
||||
let mut registry = Self::new();
|
||||
|
||||
// openapi.paths is of type Paths
|
||||
for (path, path_item) in openapi.paths.paths.iter() {
|
||||
registry.process_path_item(path, path_item);
|
||||
}
|
||||
|
||||
registry
|
||||
}
|
||||
|
||||
pub fn register_tool(&mut self, tool: McpTool) {
|
||||
self.tools.insert(tool.name.clone(), tool);
|
||||
}
|
||||
|
||||
pub fn get_tool(&self, name: &str) -> Option<&McpTool> {
|
||||
self.tools.get(name)
|
||||
}
|
||||
|
||||
pub fn list_tools(&self) -> Vec<Tool> {
|
||||
self.tools
|
||||
.values()
|
||||
.map(|mcp_tool| Tool {
|
||||
name: mcp_tool.name.clone(),
|
||||
description: mcp_tool.description.clone(),
|
||||
input_schema: mcp_tool.input_schema.clone(),
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn process_path_item(&mut self, path: &str, path_item: &PathItem) {
|
||||
let methods = [
|
||||
("GET", &path_item.get),
|
||||
("POST", &path_item.post),
|
||||
("PUT", &path_item.put),
|
||||
("DELETE", &path_item.delete),
|
||||
("PATCH", &path_item.patch),
|
||||
];
|
||||
|
||||
for (method_type, operation) in methods {
|
||||
if let Some(op) = operation {
|
||||
if let Some(tool) = McpTool::from_operation(path, method_type, op) {
|
||||
self.register_tool(tool);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl McpTool {
|
||||
pub fn from_openapi_path(
|
||||
path: &str,
|
||||
method: &str,
|
||||
path_item: &PathItem,
|
||||
) -> Self {
|
||||
// Get the operation based on method
|
||||
let operation = match method.to_uppercase().as_str() {
|
||||
"GET" => path_item.get.as_ref(),
|
||||
"POST" => path_item.post.as_ref(),
|
||||
"PUT" => path_item.put.as_ref(),
|
||||
"DELETE" => path_item.delete.as_ref(),
|
||||
"PATCH" => path_item.patch.as_ref(),
|
||||
_ => None,
|
||||
};
|
||||
|
||||
if let Some(op) = operation {
|
||||
Self::from_operation(path, method, op).unwrap_or_else(|| {
|
||||
// Fallback if operation parsing fails
|
||||
let name = Self::generate_tool_name(path, method);
|
||||
let description = format!("{} {}", method, path);
|
||||
|
||||
Self {
|
||||
name,
|
||||
description,
|
||||
input_schema: json!({
|
||||
"type": "object",
|
||||
"properties": {},
|
||||
"required": []
|
||||
}),
|
||||
http_method: method.to_string(),
|
||||
path_template: path.to_string(),
|
||||
}
|
||||
})
|
||||
} else {
|
||||
// No operation found, use basic extraction
|
||||
let name = Self::generate_tool_name(path, method);
|
||||
let description = format!("{} {}", method, path);
|
||||
|
||||
// Extract path parameters from the path template
|
||||
let mut properties = serde_json::Map::new();
|
||||
let mut required = Vec::new();
|
||||
|
||||
// Find parameters in curly braces
|
||||
let re = regex::Regex::new(r"\{([^}]+)\}").unwrap();
|
||||
for cap in re.captures_iter(path) {
|
||||
let param_name = &cap[1];
|
||||
let camel_name = to_camel_case(param_name);
|
||||
|
||||
properties.insert(
|
||||
camel_name.clone(),
|
||||
json!({
|
||||
"type": "string",
|
||||
"description": format!("The {}", param_name.replace('_', " "))
|
||||
}),
|
||||
);
|
||||
required.push(camel_name);
|
||||
}
|
||||
|
||||
Self {
|
||||
name,
|
||||
description,
|
||||
input_schema: json!({
|
||||
"type": "object",
|
||||
"properties": properties,
|
||||
"required": required
|
||||
}),
|
||||
http_method: method.to_string(),
|
||||
path_template: path.to_string(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn from_operation(path: &str, method: &str, operation: &Operation) -> Option<Self> {
|
||||
let name = Self::generate_tool_name(path, method);
|
||||
let description = operation
|
||||
.summary
|
||||
.as_ref()
|
||||
.or(operation.description.as_ref())
|
||||
.cloned()
|
||||
.unwrap_or_else(|| format!("{} {}", method, path));
|
||||
|
||||
let mut properties = serde_json::Map::new();
|
||||
let mut required = Vec::new();
|
||||
|
||||
// Extract path parameters
|
||||
if let Some(params) = &operation.parameters {
|
||||
for param in params {
|
||||
let camel_name = to_camel_case(¶m.name);
|
||||
|
||||
properties.insert(
|
||||
camel_name.clone(),
|
||||
json!({
|
||||
"type": "string",
|
||||
"description": param.description.as_deref().unwrap_or("")
|
||||
}),
|
||||
);
|
||||
|
||||
if matches!(param.required, utoipa::openapi::Required::True) {
|
||||
required.push(camel_name);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Extract request body schema
|
||||
if let Some(request_body) = &operation.request_body {
|
||||
if let Some(content) = request_body.content.get("application/json") {
|
||||
if let Some(_schema) = &content.schema {
|
||||
// Special handling for known endpoints
|
||||
if path.contains("/documents") && method == "POST" {
|
||||
// Document addition endpoint expects an array
|
||||
properties.insert(
|
||||
"documents".to_string(),
|
||||
json!({
|
||||
"type": "array",
|
||||
"items": {"type": "object"},
|
||||
"description": "Array of documents to add or update"
|
||||
}),
|
||||
);
|
||||
required.push("documents".to_string());
|
||||
} else if path.contains("/search") {
|
||||
// Search endpoint has specific properties
|
||||
properties.insert("q".to_string(), json!({"type": "string", "description": "Query string"}));
|
||||
properties.insert("limit".to_string(), json!({"type": "integer", "description": "Maximum number of results", "default": 20}));
|
||||
properties.insert("offset".to_string(), json!({"type": "integer", "description": "Number of results to skip", "default": 0}));
|
||||
properties.insert("filter".to_string(), json!({"type": "string", "description": "Filter expression"}));
|
||||
} else {
|
||||
// Generic request body handling
|
||||
properties.insert(
|
||||
"body".to_string(),
|
||||
json!({
|
||||
"type": "object",
|
||||
"description": "Request body"
|
||||
}),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let input_schema = json!({
|
||||
"type": "object",
|
||||
"properties": properties,
|
||||
"required": required,
|
||||
});
|
||||
|
||||
Some(Self {
|
||||
name,
|
||||
description,
|
||||
input_schema,
|
||||
http_method: method.to_string(),
|
||||
path_template: path.to_string(),
|
||||
})
|
||||
}
|
||||
|
||||
pub fn generate_tool_name(path: &str, method: &str) -> String {
|
||||
let parts: Vec<&str> = path
|
||||
.split('/')
|
||||
.filter(|s| !s.is_empty() && !s.starts_with('{'))
|
||||
.collect();
|
||||
|
||||
let resource = parts.last().unwrap_or(&"resource");
|
||||
// Check if the path ends with a resource name (not a parameter)
|
||||
let ends_with_param = path.ends_with('}');
|
||||
|
||||
match method.to_uppercase().as_str() {
|
||||
"GET" => {
|
||||
if ends_with_param {
|
||||
// Getting a single resource by ID
|
||||
format!("get{}", to_pascal_case(&singularize(resource)))
|
||||
} else {
|
||||
// Getting a collection
|
||||
if resource == &"keys" {
|
||||
"getApiKeys".to_string()
|
||||
} else if resource.ends_with('s') {
|
||||
format!("get{}", to_pascal_case(resource))
|
||||
} else {
|
||||
format!("get{}", to_pascal_case(&pluralize(resource)))
|
||||
}
|
||||
}
|
||||
}
|
||||
"POST" => {
|
||||
if resource == &"search" {
|
||||
"searchDocuments".to_string()
|
||||
} else if resource == &"multi-search" {
|
||||
"multiSearch".to_string()
|
||||
} else if resource == &"swap-indexes" {
|
||||
"swapIndexes".to_string()
|
||||
} else if resource == &"documents" {
|
||||
"addDocuments".to_string()
|
||||
} else if resource == &"keys" {
|
||||
"createApiKey".to_string()
|
||||
} else {
|
||||
format!("create{}", to_pascal_case(&singularize(resource)))
|
||||
}
|
||||
}
|
||||
"PUT" => format!("update{}", to_pascal_case(&singularize(resource))),
|
||||
"DELETE" => {
|
||||
if resource == &"documents" && !ends_with_param {
|
||||
"deleteDocuments".to_string()
|
||||
} else {
|
||||
format!("delete{}", to_pascal_case(&singularize(resource)))
|
||||
}
|
||||
},
|
||||
"PATCH" => {
|
||||
if resource == &"settings" {
|
||||
"updateSettings".to_string()
|
||||
} else {
|
||||
format!("update{}", to_pascal_case(&singularize(resource)))
|
||||
}
|
||||
},
|
||||
_ => format!("{}{}", method.to_lowercase(), to_pascal_case(resource)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn to_camel_case(s: &str) -> String {
|
||||
let parts: Vec<&str> = s.split(&['_', '-'][..]).collect();
|
||||
if parts.is_empty() {
|
||||
return String::new();
|
||||
}
|
||||
|
||||
let mut result = parts[0].to_lowercase();
|
||||
for part in &parts[1..] {
|
||||
result.push_str(&to_pascal_case(part));
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
fn to_pascal_case(s: &str) -> String {
|
||||
s.split(&['_', '-'][..])
|
||||
.map(|part| {
|
||||
let mut chars = part.chars();
|
||||
chars
|
||||
.next()
|
||||
.map(|c| c.to_uppercase().collect::<String>() + chars.as_str().to_lowercase().as_str())
|
||||
.unwrap_or_default()
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn singularize(word: &str) -> String {
|
||||
if word.ends_with("ies") {
|
||||
word[..word.len() - 3].to_string() + "y"
|
||||
} else if word.ends_with("es") {
|
||||
word[..word.len() - 2].to_string()
|
||||
} else if word.ends_with('s') {
|
||||
word[..word.len() - 1].to_string()
|
||||
} else {
|
||||
word.to_string()
|
||||
}
|
||||
}
|
||||
|
||||
fn pluralize(word: &str) -> String {
|
||||
if word.ends_with('y') {
|
||||
word[..word.len() - 1].to_string() + "ies"
|
||||
} else if word.ends_with('s') || word.ends_with('x') || word.ends_with("ch") {
|
||||
word.to_string() + "es"
|
||||
} else {
|
||||
word.to_string() + "s"
|
||||
}
|
||||
}
|
||||
|
||||
fn extract_schema_properties(schema: &utoipa::openapi::RefOr<utoipa::openapi::Schema>) -> Option<serde_json::Map<String, Value>> {
|
||||
// This is a simplified extraction - in a real implementation,
|
||||
// we would properly handle $ref resolution and nested schemas
|
||||
match schema {
|
||||
utoipa::openapi::RefOr::T(_schema) => {
|
||||
// Extract properties from the schema
|
||||
// This would need proper implementation based on the schema type
|
||||
Some(serde_json::Map::new())
|
||||
}
|
||||
utoipa::openapi::RefOr::Ref { .. } => {
|
||||
// Handle schema references
|
||||
Some(serde_json::Map::new())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_tool_name_generation() {
|
||||
assert_eq!(McpTool::generate_tool_name("/indexes", "GET"), "getIndexes");
|
||||
assert_eq!(McpTool::generate_tool_name("/indexes/{index_uid}", "GET"), "getIndex");
|
||||
assert_eq!(McpTool::generate_tool_name("/indexes/{index_uid}/search", "POST"), "searchDocuments");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_camel_case_conversion() {
|
||||
assert_eq!(to_camel_case("index_uid"), "indexUid");
|
||||
assert_eq!(to_camel_case("document-id"), "documentId");
|
||||
assert_eq!(to_camel_case("simple"), "simple");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_pascal_case_conversion() {
|
||||
assert_eq!(to_pascal_case("index"), "Index");
|
||||
assert_eq!(to_pascal_case("multi-search"), "MultiSearch");
|
||||
assert_eq!(to_pascal_case("api_key"), "ApiKey");
|
||||
}
|
||||
}
|
325
crates/meilisearch-mcp/src/server.rs
Normal file
325
crates/meilisearch-mcp/src/server.rs
Normal file
@ -0,0 +1,325 @@
|
||||
use crate::error::Error;
|
||||
use crate::protocol::*;
|
||||
use crate::registry::McpToolRegistry;
|
||||
use actix_web::{web, HttpRequest, HttpResponse};
|
||||
use async_stream::try_stream;
|
||||
use futures::stream::{StreamExt, TryStreamExt};
|
||||
use serde_json::{json, Value};
|
||||
use std::sync::Arc;
|
||||
|
||||
pub struct McpServer {
|
||||
registry: Arc<McpToolRegistry>,
|
||||
meilisearch_client: Option<Arc<dyn MeilisearchClient>>,
|
||||
}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
pub trait MeilisearchClient: Send + Sync {
|
||||
async fn call_endpoint(
|
||||
&self,
|
||||
method: &str,
|
||||
path: &str,
|
||||
body: Option<Value>,
|
||||
auth_header: Option<String>,
|
||||
) -> Result<Value, Error>;
|
||||
}
|
||||
|
||||
impl McpServer {
|
||||
pub fn new(registry: McpToolRegistry) -> Self {
|
||||
Self {
|
||||
registry: Arc::new(registry),
|
||||
meilisearch_client: None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn with_client(mut self, client: Arc<dyn MeilisearchClient>) -> Self {
|
||||
self.meilisearch_client = Some(client);
|
||||
self
|
||||
}
|
||||
|
||||
pub async fn handle_json_rpc_request(&self, request: JsonRpcRequest) -> JsonRpcResponse {
|
||||
// Parse the method and params
|
||||
let result = match request.method.as_str() {
|
||||
"initialize" => {
|
||||
let params: InitializeParams = match request.params {
|
||||
Some(p) => match serde_json::from_value(p) {
|
||||
Ok(params) => params,
|
||||
Err(e) => return self.error_response(request.id, INVALID_PARAMS, &format!("Invalid params: {}", e)),
|
||||
},
|
||||
None => InitializeParams::default(),
|
||||
};
|
||||
self.handle_initialize(params)
|
||||
}
|
||||
"tools/list" => self.handle_list_tools(),
|
||||
"tools/call" => {
|
||||
let params: CallToolParams = match request.params {
|
||||
Some(p) => match serde_json::from_value(p) {
|
||||
Ok(params) => params,
|
||||
Err(e) => return self.error_response(request.id, INVALID_PARAMS, &format!("Invalid params: {}", e)),
|
||||
},
|
||||
None => return self.error_response(request.id, INVALID_PARAMS, "Missing params"),
|
||||
};
|
||||
self.handle_call_tool(params).await
|
||||
}
|
||||
_ => return self.error_response(request.id, METHOD_NOT_FOUND, &format!("Method not found: {}", request.method)),
|
||||
};
|
||||
|
||||
match result {
|
||||
Ok(value) => JsonRpcResponse::Success {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
result: value,
|
||||
id: request.id,
|
||||
},
|
||||
Err((code, message, data)) => JsonRpcResponse::Error {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
error: JsonRpcError { code, message, data },
|
||||
id: request.id,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
fn error_response(&self, id: Value, code: i32, message: &str) -> JsonRpcResponse {
|
||||
JsonRpcResponse::Error {
|
||||
jsonrpc: "2.0".to_string(),
|
||||
error: JsonRpcError {
|
||||
code,
|
||||
message: message.to_string(),
|
||||
data: None,
|
||||
},
|
||||
id,
|
||||
}
|
||||
}
|
||||
|
||||
fn handle_initialize(&self, _params: InitializeParams) -> Result<Value, (i32, String, Option<Value>)> {
|
||||
let result = InitializeResult {
|
||||
protocol_version: "2024-11-05".to_string(),
|
||||
capabilities: ServerCapabilities {
|
||||
tools: ToolsCapability {
|
||||
list_changed: true,
|
||||
},
|
||||
experimental: json!({}),
|
||||
},
|
||||
server_info: ServerInfo {
|
||||
name: "meilisearch-mcp".to_string(),
|
||||
version: env!("CARGO_PKG_VERSION").to_string(),
|
||||
},
|
||||
};
|
||||
|
||||
Ok(serde_json::to_value(result).unwrap())
|
||||
}
|
||||
|
||||
fn handle_list_tools(&self) -> Result<Value, (i32, String, Option<Value>)> {
|
||||
let tools = self.registry.list_tools();
|
||||
let result = ListToolsResult { tools };
|
||||
Ok(serde_json::to_value(result).unwrap())
|
||||
}
|
||||
|
||||
async fn handle_call_tool(&self, params: CallToolParams) -> Result<Value, (i32, String, Option<Value>)> {
|
||||
// Get the tool definition
|
||||
let tool = match self.registry.get_tool(¶ms.name) {
|
||||
Some(tool) => tool,
|
||||
None => {
|
||||
return Err((
|
||||
METHOD_NOT_FOUND,
|
||||
format!("Tool not found: {}", params.name),
|
||||
None,
|
||||
));
|
||||
}
|
||||
};
|
||||
|
||||
// Validate parameters
|
||||
if let Err(e) = self.validate_parameters(¶ms.arguments, &tool.input_schema) {
|
||||
return Err((
|
||||
INVALID_PARAMS,
|
||||
format!("Invalid parameters: {}", e),
|
||||
Some(json!({ "schema": tool.input_schema })),
|
||||
));
|
||||
}
|
||||
|
||||
// Execute the tool
|
||||
match self.execute_tool(tool, params.arguments).await {
|
||||
Ok(result_text) => {
|
||||
let result = CallToolResult {
|
||||
content: vec![ToolContent {
|
||||
content_type: "text".to_string(),
|
||||
text: result_text,
|
||||
}],
|
||||
is_error: None,
|
||||
};
|
||||
Ok(serde_json::to_value(result).unwrap())
|
||||
}
|
||||
Err(e) => Err((
|
||||
INTERNAL_ERROR,
|
||||
format!("Tool execution failed: {}", e),
|
||||
None,
|
||||
)),
|
||||
}
|
||||
}
|
||||
|
||||
fn validate_parameters(&self, args: &Value, schema: &Value) -> Result<(), String> {
|
||||
// Check if args is an object
|
||||
if !args.is_object() {
|
||||
return Err("Arguments must be an object".to_string());
|
||||
}
|
||||
|
||||
// Basic validation - check required fields
|
||||
if let (Some(args_obj), Some(schema_obj)) = (args.as_object(), schema.as_object()) {
|
||||
if let Some(required) = schema_obj.get("required").and_then(|r| r.as_array()) {
|
||||
for req_field in required {
|
||||
if let Some(field_name) = req_field.as_str() {
|
||||
if !args_obj.contains_key(field_name) {
|
||||
return Err(format!("Missing required field: {}", field_name));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn execute_tool(
|
||||
&self,
|
||||
tool: &crate::registry::McpTool,
|
||||
mut arguments: Value,
|
||||
) -> Result<String, Error> {
|
||||
// Extract authentication if provided
|
||||
let auth_header = arguments
|
||||
.as_object_mut()
|
||||
.and_then(|obj| obj.remove("_auth"))
|
||||
.and_then(|auth| {
|
||||
auth.get("apiKey")
|
||||
.and_then(|k| k.as_str())
|
||||
.map(|s| s.to_string())
|
||||
})
|
||||
.map(|key| format!("Bearer {}", key));
|
||||
|
||||
// Build the actual path by replacing parameters
|
||||
let mut path = tool.path_template.clone();
|
||||
if let Some(args_obj) = arguments.as_object() {
|
||||
for (key, value) in args_obj {
|
||||
let param_pattern = format!("{{{}}}", camel_to_snake_case(key));
|
||||
if let Some(val_str) = value.as_str() {
|
||||
path = path.replace(¶m_pattern, val_str);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Prepare request body for POST/PUT/PATCH methods
|
||||
let body = match tool.http_method.as_str() {
|
||||
"POST" | "PUT" | "PATCH" => {
|
||||
// Remove path parameters from body
|
||||
if let Some(args_obj) = arguments.as_object_mut() {
|
||||
let mut body_obj = args_obj.clone();
|
||||
// Remove any parameters that were used in the path
|
||||
for (key, _) in args_obj.iter() {
|
||||
let param_pattern = format!("{{{}}}", camel_to_snake_case(key));
|
||||
if tool.path_template.contains(¶m_pattern) {
|
||||
body_obj.remove(key);
|
||||
}
|
||||
}
|
||||
Some(Value::Object(body_obj))
|
||||
} else {
|
||||
Some(arguments.clone())
|
||||
}
|
||||
}
|
||||
_ => None,
|
||||
};
|
||||
|
||||
// Execute the request
|
||||
if let Some(client) = &self.meilisearch_client {
|
||||
match client.call_endpoint(&tool.http_method, &path, body, auth_header).await {
|
||||
Ok(response) => Ok(serde_json::to_string_pretty(&response)?),
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
} else {
|
||||
// Mock response for testing
|
||||
Ok(json!({
|
||||
"status": "success",
|
||||
"message": format!("Executed {} {}", tool.http_method, path)
|
||||
})
|
||||
.to_string())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn mcp_sse_handler(
|
||||
req: HttpRequest,
|
||||
_server: web::Data<McpServer>,
|
||||
) -> Result<HttpResponse, actix_web::Error> {
|
||||
// MCP SSE transport implementation
|
||||
// This endpoint handles server-to-client messages via SSE
|
||||
// Client-to-server messages come via POST requests
|
||||
|
||||
// Check for session ID header
|
||||
let session_id = req.headers()
|
||||
.get("Mcp-Session-Id")
|
||||
.and_then(|h| h.to_str().ok())
|
||||
.map(|s| s.to_string())
|
||||
.unwrap_or_else(|| uuid::Uuid::new_v4().to_string());
|
||||
|
||||
// Check for Last-Event-ID header for resumability
|
||||
let _last_event_id = req.headers()
|
||||
.get("Last-Event-ID")
|
||||
.and_then(|h| h.to_str().ok())
|
||||
.and_then(|s| s.parse::<u64>().ok());
|
||||
|
||||
// Create a channel for this SSE connection
|
||||
let (_tx, mut rx) = tokio::sync::mpsc::unbounded_channel::<String>();
|
||||
|
||||
// Store the sender for this session (in a real implementation, you'd use a shared state)
|
||||
// For now, we'll just keep the connection open
|
||||
|
||||
let stream = try_stream! {
|
||||
// Always send the endpoint event first
|
||||
yield format!("event: endpoint\ndata: {{\"uri\": \"/mcp\"}}\n\n");
|
||||
|
||||
// Keep connection alive and handle any messages
|
||||
loop {
|
||||
tokio::select! {
|
||||
Some(message) = rx.recv() => {
|
||||
yield message;
|
||||
}
|
||||
_ = tokio::time::sleep(tokio::time::Duration::from_secs(30)) => {
|
||||
yield format!(": keepalive\n\n");
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
let mut response = HttpResponse::Ok();
|
||||
response.content_type("text/event-stream");
|
||||
response.insert_header(("Cache-Control", "no-cache"));
|
||||
response.insert_header(("Connection", "keep-alive"));
|
||||
response.insert_header(("X-Accel-Buffering", "no"));
|
||||
response.insert_header(("Access-Control-Allow-Origin", "*"));
|
||||
response.insert_header(("Access-Control-Allow-Headers", "*"));
|
||||
response.insert_header(("Mcp-Session-Id", session_id));
|
||||
|
||||
Ok(response.streaming(stream.map(|result: Result<String, anyhow::Error>| {
|
||||
result.map(|s| actix_web::web::Bytes::from(s))
|
||||
}).map_err(|e| actix_web::error::ErrorInternalServerError(e))))
|
||||
}
|
||||
|
||||
|
||||
fn camel_to_snake_case(s: &str) -> String {
|
||||
let mut result = String::new();
|
||||
for (i, ch) in s.chars().enumerate() {
|
||||
if ch.is_uppercase() && i > 0 {
|
||||
result.push('_');
|
||||
}
|
||||
result.push(ch.to_lowercase().next().unwrap());
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_camel_to_snake_case() {
|
||||
assert_eq!(camel_to_snake_case("indexUid"), "index_uid");
|
||||
assert_eq!(camel_to_snake_case("documentId"), "document_id");
|
||||
assert_eq!(camel_to_snake_case("simple"), "simple");
|
||||
}
|
||||
|
||||
}
|
@ -50,6 +50,7 @@ jsonwebtoken = "9.3.0"
|
||||
lazy_static = "1.5.0"
|
||||
meilisearch-auth = { path = "../meilisearch-auth" }
|
||||
meilisearch-types = { path = "../meilisearch-types" }
|
||||
meilisearch-mcp = { path = "../meilisearch-mcp", optional = true }
|
||||
mimalloc = { version = "0.1.43", default-features = false }
|
||||
mime = "0.3.17"
|
||||
num_cpus = "1.16.0"
|
||||
@ -142,6 +143,7 @@ zip = { version = "2.3.0", optional = true }
|
||||
default = ["meilisearch-types/all-tokenizations", "mini-dashboard"]
|
||||
swagger = ["utoipa-scalar"]
|
||||
test-ollama = []
|
||||
mcp = ["meilisearch-mcp"]
|
||||
mini-dashboard = [
|
||||
"static-files",
|
||||
"anyhow",
|
||||
|
@ -630,6 +630,7 @@ pub fn configure_data(
|
||||
.app_data(
|
||||
web::QueryConfig::default().error_handler(|err, _req| PayloadError::from(err).into()),
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
#[cfg(feature = "mini-dashboard")]
|
||||
|
@ -114,6 +114,13 @@ pub fn configure(cfg: &mut web::ServiceConfig) {
|
||||
.service(web::scope("/metrics").configure(metrics::configure))
|
||||
.service(web::scope("/experimental-features").configure(features::configure))
|
||||
.service(web::scope("/network").configure(network::configure));
|
||||
|
||||
#[cfg(feature = "mcp")]
|
||||
{
|
||||
use meilisearch_mcp::integration::configure_mcp_route;
|
||||
let openapi = MeilisearchApi::openapi();
|
||||
configure_mcp_route(cfg, openapi);
|
||||
}
|
||||
|
||||
#[cfg(feature = "swagger")]
|
||||
{
|
||||
|
@ -28,6 +28,7 @@ async fn error_delete_unexisting_index() {
|
||||
let (task, code) = index.delete_index_fail().await;
|
||||
|
||||
assert_eq!(code, 202);
|
||||
index.wait_task(task.uid()).await.failed();
|
||||
|
||||
let expected_response = json!({
|
||||
"message": "Index `DOES_NOT_EXISTS` not found.",
|
||||
@ -57,7 +58,7 @@ async fn loop_delete_add_documents() {
|
||||
}
|
||||
|
||||
for task in tasks {
|
||||
let response = index.wait_task(task).await;
|
||||
let response = index.wait_task(task).await.succeeded();
|
||||
assert_eq!(response["status"], "succeeded", "{}", response);
|
||||
}
|
||||
}
|
||||
|
@ -52,19 +52,28 @@ async fn no_index_return_empty_list() {
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn list_multiple_indexes() {
|
||||
let server = Server::new().await;
|
||||
server.index("test").create(None).await;
|
||||
let (task, _status_code) = server.index("test1").create(Some("key")).await;
|
||||
let server = Server::new_shared();
|
||||
|
||||
server.index("test").wait_task(task.uid()).await.succeeded();
|
||||
let index_without_key = server.unique_index();
|
||||
let (response_without_key, _status_code) = index_without_key.create(None).await;
|
||||
|
||||
let (response, code) = server.list_indexes(None, None).await;
|
||||
let index_with_key = server.unique_index();
|
||||
let (response_with_key, _status_code) = index_with_key.create(Some("key")).await;
|
||||
|
||||
index_without_key.wait_task(response_without_key.uid()).await.succeeded();
|
||||
index_with_key.wait_task(response_with_key.uid()).await.succeeded();
|
||||
|
||||
let (response, code) = server.list_indexes(None, Some(1000)).await;
|
||||
assert_eq!(code, 200);
|
||||
assert!(response["results"].is_array());
|
||||
let arr = response["results"].as_array().unwrap();
|
||||
assert_eq!(arr.len(), 2);
|
||||
assert!(arr.iter().any(|entry| entry["uid"] == "test" && entry["primaryKey"] == Value::Null));
|
||||
assert!(arr.iter().any(|entry| entry["uid"] == "test1" && entry["primaryKey"] == "key"));
|
||||
assert!(arr.len() >= 2, "Expected at least 2 indexes.");
|
||||
assert!(arr
|
||||
.iter()
|
||||
.any(|entry| entry["uid"] == index_without_key.uid && entry["primaryKey"] == Value::Null));
|
||||
assert!(arr
|
||||
.iter()
|
||||
.any(|entry| entry["uid"] == index_with_key.uid && entry["primaryKey"] == "key"));
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
|
@ -1,10 +1,11 @@
|
||||
use crate::common::Server;
|
||||
use crate::common::{shared_does_not_exists_index, Server};
|
||||
|
||||
use crate::json;
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn stats() {
|
||||
let server = Server::new().await;
|
||||
let index = server.index("test");
|
||||
let server = Server::new_shared();
|
||||
let index = server.unique_index();
|
||||
let (task, code) = index.create(Some("id")).await;
|
||||
|
||||
assert_eq!(code, 202);
|
||||
@ -15,7 +16,7 @@ async fn stats() {
|
||||
|
||||
assert_eq!(code, 200);
|
||||
assert_eq!(response["numberOfDocuments"], 0);
|
||||
assert!(response["isIndexing"] == false);
|
||||
assert_eq!(response["isIndexing"], false);
|
||||
assert!(response["fieldDistribution"].as_object().unwrap().is_empty());
|
||||
|
||||
let documents = json!([
|
||||
@ -31,7 +32,6 @@ async fn stats() {
|
||||
|
||||
let (response, code) = index.add_documents(documents, None).await;
|
||||
assert_eq!(code, 202);
|
||||
assert_eq!(response["taskUid"], 1);
|
||||
|
||||
index.wait_task(response.uid()).await.succeeded();
|
||||
|
||||
@ -39,7 +39,7 @@ async fn stats() {
|
||||
|
||||
assert_eq!(code, 200);
|
||||
assert_eq!(response["numberOfDocuments"], 2);
|
||||
assert!(response["isIndexing"] == false);
|
||||
assert_eq!(response["isIndexing"], false);
|
||||
assert_eq!(response["fieldDistribution"]["id"], 2);
|
||||
assert_eq!(response["fieldDistribution"]["name"], 1);
|
||||
assert_eq!(response["fieldDistribution"]["age"], 1);
|
||||
@ -47,11 +47,11 @@ async fn stats() {
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn error_get_stats_unexisting_index() {
|
||||
let server = Server::new().await;
|
||||
let (response, code) = server.index("test").stats().await;
|
||||
let index = shared_does_not_exists_index().await;
|
||||
let (response, code) = index.stats().await;
|
||||
|
||||
let expected_response = json!({
|
||||
"message": "Index `test` not found.",
|
||||
"message": format!("Index `{}` not found.", index.uid),
|
||||
"code": "index_not_found",
|
||||
"type": "invalid_request",
|
||||
"link": "https://docs.meilisearch.com/errors#index_not_found"
|
||||
|
@ -112,6 +112,26 @@ async fn simple_search() {
|
||||
.await;
|
||||
}
|
||||
|
||||
/// See <https://github.com/meilisearch/meilisearch/issues/5547>
|
||||
#[actix_rt::test]
|
||||
async fn bug_5547() {
|
||||
let server = Server::new().await;
|
||||
let index = server.index("big_fst");
|
||||
let (response, _code) = index.create(None).await;
|
||||
index.wait_task(response.uid()).await.succeeded();
|
||||
|
||||
let mut documents = Vec::new();
|
||||
for i in 0..65_535 {
|
||||
documents.push(json!({"id": i, "title": format!("title{i}")}));
|
||||
}
|
||||
|
||||
let (response, _code) = index.add_documents(json!(documents), Some("id")).await;
|
||||
index.wait_task(response.uid()).await.succeeded();
|
||||
let (response, code) = index.search_post(json!({"q": "title"})).await;
|
||||
assert_eq!(code, 200);
|
||||
snapshot!(response["hits"], @r###"[{"id":0,"title":"title0"},{"id":1,"title":"title1"},{"id":10,"title":"title10"},{"id":100,"title":"title100"},{"id":101,"title":"title101"},{"id":102,"title":"title102"},{"id":103,"title":"title103"},{"id":104,"title":"title104"},{"id":105,"title":"title105"},{"id":106,"title":"title106"},{"id":107,"title":"title107"},{"id":108,"title":"title108"},{"id":1000,"title":"title1000"},{"id":1001,"title":"title1001"},{"id":1002,"title":"title1002"},{"id":1003,"title":"title1003"},{"id":1004,"title":"title1004"},{"id":1005,"title":"title1005"},{"id":1006,"title":"title1006"},{"id":1007,"title":"title1007"}]"###);
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn search_with_stop_word() {
|
||||
// related to https://github.com/meilisearch/meilisearch/issues/4984
|
||||
|
@ -416,3 +416,381 @@ async fn phrase_search_on_title() {
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
static NESTED_SEARCH_DOCUMENTS: Lazy<Value> = Lazy::new(|| {
|
||||
json!([
|
||||
{
|
||||
"details": {
|
||||
"title": "Shazam!",
|
||||
"desc": "a Captain Marvel ersatz",
|
||||
"weaknesses": ["magic", "requires transformation"],
|
||||
"outfit": {
|
||||
"has_cape": true,
|
||||
"colors": {
|
||||
"primary": "red",
|
||||
"secondary": "gold"
|
||||
}
|
||||
}
|
||||
},
|
||||
"id": "1",
|
||||
},
|
||||
{
|
||||
"details": {
|
||||
"title": "Captain Planet",
|
||||
"desc": "He's not part of the Marvel Cinematic Universe",
|
||||
"blue_skin": true,
|
||||
"outfit": {
|
||||
"has_cape": false
|
||||
}
|
||||
},
|
||||
"id": "2",
|
||||
},
|
||||
{
|
||||
"details": {
|
||||
"title": "Captain Marvel",
|
||||
"desc": "a Shazam ersatz",
|
||||
"weaknesses": ["magic", "power instability"],
|
||||
"outfit": {
|
||||
"has_cape": false
|
||||
}
|
||||
},
|
||||
"id": "3",
|
||||
}])
|
||||
});
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_search_on_title_with_prefix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
// Wildcard should match to 'details.' attribute
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["*.title"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_search_with_suffix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
// Wildcard should match to any attribute inside 'details.'
|
||||
// It's worth noting the difference between 'details.*' and '*.title'
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["details.*"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "1"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
|
||||
// Should return 1 document (ids: 1)
|
||||
index
|
||||
.search(
|
||||
json!({"q": "gold", "attributesToSearchOn": ["details.*"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "1"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
|
||||
// Should return 2 documents (ids: 1 and 2)
|
||||
index
|
||||
.search(
|
||||
json!({"q": "true", "attributesToSearchOn": ["details.*"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "1"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_search_on_title_restricted_set_with_suffix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
let (task, _status_code) =
|
||||
index.update_settings_searchable_attributes(json!(["details.title"])).await;
|
||||
index.wait_task(task.uid()).await.succeeded();
|
||||
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["details.*"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_search_no_searchable_attribute_set_with_any_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["unknown.*", "*.unknown"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(response["hits"].as_array().unwrap().len(), @"0");
|
||||
},
|
||||
)
|
||||
.await;
|
||||
|
||||
let (task, _status_code) = index.update_settings_searchable_attributes(json!(["*"])).await;
|
||||
index.wait_task(task.uid()).await.succeeded();
|
||||
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["unknown.*", "*.unknown"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(response["hits"].as_array().unwrap().len(), @"0");
|
||||
},
|
||||
)
|
||||
.await;
|
||||
|
||||
let (task, _status_code) = index.update_settings_searchable_attributes(json!(["*"])).await;
|
||||
index.wait_task(task.uid()).await.succeeded();
|
||||
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["unknown.*", "*.unknown", "*.title"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_prefix_search_on_title_with_prefix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
// Nested prefix search with prefix wildcard should return 2 documents (ids: 2 and 3).
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Mar", "attributesToSearchOn": ["*.title"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_prefix_search_on_details_with_suffix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Mar", "attributesToSearchOn": ["details.*"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "1"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_prefix_search_on_weaknesses_with_suffix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
// Wildcard search on nested weaknesses should return 2 documents (ids: 1 and 3)
|
||||
index
|
||||
.search(
|
||||
json!({"q": "mag", "attributesToSearchOn": ["details.*"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "1"
|
||||
},
|
||||
{
|
||||
"id": "3"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_search_on_title_matching_strategy_all() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
// Nested search matching strategy all should only return 1 document (ids: 3)
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["*.title"], "matchingStrategy": "all", "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
}
|
||||
]"###);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_attributes_ranking_rule_order_with_prefix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
// Document 3 should appear before documents 1 and 2
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["*.desc", "*.title"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "1"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]
|
||||
"###
|
||||
);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
#[actix_rt::test]
|
||||
async fn nested_attributes_ranking_rule_order_with_suffix_wildcard() {
|
||||
let server = Server::new().await;
|
||||
let index = index_with_documents(&server, &NESTED_SEARCH_DOCUMENTS).await;
|
||||
|
||||
// Document 3 should appear before documents 1 and 2
|
||||
index
|
||||
.search(
|
||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["details.*"], "attributesToRetrieve": ["id"]}),
|
||||
|response, code| {
|
||||
snapshot!(code, @"200 OK");
|
||||
snapshot!(json_string!(response["hits"]),
|
||||
@r###"
|
||||
[
|
||||
{
|
||||
"id": "3"
|
||||
},
|
||||
{
|
||||
"id": "1"
|
||||
},
|
||||
{
|
||||
"id": "2"
|
||||
}
|
||||
]
|
||||
"###
|
||||
);
|
||||
},
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
@ -50,7 +50,7 @@ impl AttributePatterns {
|
||||
///
|
||||
/// * `pattern` - The pattern to match against.
|
||||
/// * `str` - The string to match against the pattern.
|
||||
fn match_pattern(pattern: &str, str: &str) -> PatternMatch {
|
||||
pub fn match_pattern(pattern: &str, str: &str) -> PatternMatch {
|
||||
// If the pattern is a wildcard, return Match
|
||||
if pattern == "*" {
|
||||
return PatternMatch::Match;
|
||||
|
@ -52,6 +52,7 @@ pub use self::geo_sort::Strategy as GeoSortStrategy;
|
||||
use self::graph_based_ranking_rule::Words;
|
||||
use self::interner::Interned;
|
||||
use self::vector_sort::VectorSort;
|
||||
use crate::attribute_patterns::{match_pattern, PatternMatch};
|
||||
use crate::constants::RESERVED_GEO_FIELD_NAME;
|
||||
use crate::index::PrefixSearch;
|
||||
use crate::localized_attributes_rules::LocalizedFieldIds;
|
||||
@ -120,17 +121,37 @@ impl<'ctx> SearchContext<'ctx> {
|
||||
let searchable_fields_weights = self.index.searchable_fields_and_weights(self.txn)?;
|
||||
let exact_attributes_ids = self.index.exact_attributes_ids(self.txn)?;
|
||||
|
||||
let mut wildcard = false;
|
||||
let mut universal_wildcard = false;
|
||||
|
||||
let mut restricted_fids = RestrictedFids::default();
|
||||
for field_name in attributes_to_search_on {
|
||||
if field_name == "*" {
|
||||
wildcard = true;
|
||||
universal_wildcard = true;
|
||||
// we cannot early exit as we want to returns error in case of unknown fields
|
||||
continue;
|
||||
}
|
||||
let searchable_weight =
|
||||
searchable_fields_weights.iter().find(|(name, _, _)| name == field_name);
|
||||
|
||||
// The field is not searchable but may contain a wildcard pattern
|
||||
if searchable_weight.is_none() && field_name.contains("*") {
|
||||
let matching_searchable_weights: Vec<_> = searchable_fields_weights
|
||||
.iter()
|
||||
.filter(|(name, _, _)| match_pattern(field_name, name) == PatternMatch::Match)
|
||||
.collect();
|
||||
|
||||
if !matching_searchable_weights.is_empty() {
|
||||
for (_name, fid, weight) in matching_searchable_weights {
|
||||
if exact_attributes_ids.contains(fid) {
|
||||
restricted_fids.exact.push((*fid, *weight));
|
||||
} else {
|
||||
restricted_fids.tolerant.push((*fid, *weight));
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
let (fid, weight) = match searchable_weight {
|
||||
// The Field id exist and the field is searchable
|
||||
Some((_name, fid, weight)) => (*fid, *weight),
|
||||
@ -160,7 +181,7 @@ impl<'ctx> SearchContext<'ctx> {
|
||||
};
|
||||
}
|
||||
|
||||
if wildcard {
|
||||
if universal_wildcard {
|
||||
self.restricted_fids = None;
|
||||
} else {
|
||||
self.restricted_fids = Some(restricted_fids);
|
||||
|
@ -92,12 +92,12 @@ fn find_one_typo_derivations(
|
||||
let mut stream = fst.search_with_state(Intersection(starts, &dfa)).into_stream();
|
||||
|
||||
while let Some((derived_word, state)) = stream.next() {
|
||||
let derived_word = std::str::from_utf8(derived_word)?;
|
||||
let derived_word = ctx.word_interner.insert(derived_word.to_owned());
|
||||
let d = dfa.distance(state.1);
|
||||
match d.to_u8() {
|
||||
0 => (),
|
||||
1 => {
|
||||
let derived_word = std::str::from_utf8(derived_word)?;
|
||||
let derived_word = ctx.word_interner.insert(derived_word.to_owned());
|
||||
let cf = visit(derived_word)?;
|
||||
if cf.is_break() {
|
||||
break;
|
||||
|
Reference in New Issue
Block a user