Skip to content

Commit a2c47f7

Browse files
authored
Merge pull request #44 from meilisearch/docs/update-claude-md-hybrid-search
Update CLAUDE.md with hybrid search implementation notes
2 parents b05aa10 + e68d0f8 commit a2c47f7

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,3 +208,6 @@ pyrightconfig.json
208208

209209
# End of https://www.toptal.com/developers/gitignore/api/python,macos
210210
.env
211+
212+
# Meilisearch data directory
213+
data.ms/

CLAUDE.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,7 @@ Tests use `simulate_tool_call()` function that:
226226
- **Test Naming**: Use descriptive test method names (e.g., `test_create_index_with_primary_key`)
227227
- **Assertions**: Test both success cases and error handling
228228
- **Coverage**: New tools must have comprehensive test coverage
229+
- **Embedder Tests**: Tests requiring Meilisearch embedder configuration should be marked with `@pytest.mark.skip` decorator
229230

230231
## Environment Configuration
231232

@@ -269,18 +270,27 @@ The repository includes Claude Code integration via GitHub Actions:
269270
### Search Tool Features
270271
- **Flexible Targeting**: Search specific index or all indices
271272
- **Rich Parameters**: Filtering, sorting, pagination support
273+
- **Hybrid Search**: Support for combining keyword and semantic search with `semanticRatio` parameter
274+
- **Vector Search**: Custom vector support for semantic similarity search
272275
- **Result Formatting**: JSON formatted responses with proper serialization
273276
- **Error Resilience**: Graceful handling of index-specific failures
274277

275278
## Development Notes
276279

277280
### Dependencies
278281
- **MCP Framework**: `mcp>=1.2.1` for protocol implementation
279-
- **Meilisearch Client**: `meilisearch>=0.33.0` for search engine integration
282+
- **Meilisearch Client**: `meilisearch>=0.34.0` for search engine integration with stable AI-powered search features
280283
- **HTTP Client**: `httpx>=0.24.0` for async HTTP operations
281284
- **Data Validation**: `pydantic>=2.0.0` for structured data handling
282285

283286
### Logging Infrastructure
284287
- **Structured Logging**: JSON-formatted logs with contextual information
285288
- **Log Directory**: `~/.meilisearch-mcp/logs/` for persistent logging
286-
- **Error Tracking**: Comprehensive error logging with tool context
289+
- **Error Tracking**: Comprehensive error logging with tool context
290+
291+
### Hybrid Search Implementation
292+
- **Dependency**: Requires `meilisearch>=0.34.0` for stable AI-powered search features
293+
- **Parameters**: `hybrid` object with `semanticRatio` (0.0-1.0) and `embedder` (required)
294+
- **Vector Support**: Custom vectors can be provided via `vector` parameter
295+
- **Testing**: Hybrid search tests require embedder configuration in Meilisearch
296+
- **Backward Compatibility**: All hybrid search parameters are optional to maintain compatibility

0 commit comments

Comments
 (0)