Skip to content

Update CLAUDE.md with hybrid search implementation notes #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025
Merged

Update CLAUDE.md with hybrid search implementation notes #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,6 @@ pyrightconfig.json

# End of https://www.toptal.com/developers/gitignore/api/python,macos
.env

# Meilisearch data directory
data.ms/
14 changes: 12 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ Tests use `simulate_tool_call()` function that:
- **Test Naming**: Use descriptive test method names (e.g., `test_create_index_with_primary_key`)
- **Assertions**: Test both success cases and error handling
- **Coverage**: New tools must have comprehensive test coverage
- **Embedder Tests**: Tests requiring Meilisearch embedder configuration should be marked with `@pytest.mark.skip` decorator

## Environment Configuration

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

## Development Notes

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

### Logging Infrastructure
- **Structured Logging**: JSON-formatted logs with contextual information
- **Log Directory**: `~/.meilisearch-mcp/logs/` for persistent logging
- **Error Tracking**: Comprehensive error logging with tool context
- **Error Tracking**: Comprehensive error logging with tool context

### Hybrid Search Implementation
- **Dependency**: Requires `meilisearch>=0.34.0` for stable AI-powered search features
- **Parameters**: `hybrid` object with `semanticRatio` (0.0-1.0) and `embedder` (required)
- **Vector Support**: Custom vectors can be provided via `vector` parameter
- **Testing**: Hybrid search tests require embedder configuration in Meilisearch
- **Backward Compatibility**: All hybrid search parameters are optional to maintain compatibility