Skip to content

Update dependencies and README #58

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

Open
rhaist wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update dependencies and README #58

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
10 changes: 5 additions & 5 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ npx @modelcontextprotocol/inspector python -m src.meilisearch_mcp

### Prerequisites for Testing
- **Meilisearch server** must be running on `http://localhost:7700`
- **Docker option**: `docker run -d -p 7700:7700 getmeili/meilisearch:v1.6`
- **Docker option**: `docker run -d -p 7700:7700 getmeili/meilisearch:v1.28`
- **Node.js** for MCP Inspector testing

## Architecture
Expand All @@ -159,7 +159,7 @@ The codebase follows a modular architecture where functionality is organized int
```
MeilisearchClient
├── IndexManager - Index creation, listing, deletion
├── DocumentManager - Document CRUD operations
├── DocumentManager - Document CRUD operations
├── SettingsManager - Index configuration management
├── TaskManager - Asynchronous task monitoring
├── KeyManager - API key management
Expand Down Expand Up @@ -214,7 +214,7 @@ All MCP tools follow a consistent pattern:
### Tool Simulation Framework
Tests use `simulate_tool_call()` function that:
- Directly invokes server tool handlers
- Bypasses MCP protocol overhead
- Bypasses MCP protocol overhead
- Returns proper `TextContent` responses
- Provides comprehensive coverage of all 20+ tools
- Enables fast test execution without MCP protocol complexity
Expand Down Expand Up @@ -242,7 +242,7 @@ Add to `claude_desktop_config.json`:
{
"mcpServers": {
"meilisearch": {
"command": "uvx",
"command": "uvx",
"args": ["-n", "meilisearch-mcp"]
}
}
Expand All @@ -259,7 +259,7 @@ The repository includes Claude Code integration via GitHub Actions:

### Core Categories
- **Connection Management**: Dynamic configuration updates
- **Index Operations**: CRUD operations for search indices
- **Index Operations**: CRUD operations for search indices
- **Document Management**: Add, retrieve, and manage documents
- **Search Capabilities**: Single and multi-index search with filtering
- **Settings Control**: Index configuration and optimization
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Use Python 3.12 slim image for smaller size
FROM python:3.13-slim
FROM python:3.14-slim

# Set working directory
WORKDIR /app
Expand Down
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Add this to your `claude_desktop_config.json`:

```bash
# Using Docker (recommended)
docker run -d -p 7700:7700 getmeili/meilisearch:v1.6
docker run -d -p 7700:7700 getmeili/meilisearch:v1.28

# Or using Homebrew
brew install meilisearch
Expand Down Expand Up @@ -106,7 +106,7 @@ AI: I'll search for those products... Found 12 matching products!
You: "Search across all my indices for 'machine learning' and sort by date"
AI: Searching across all indices... Found 47 results from 3 indices:
- 'blog_posts': 23 articles about ML
- 'documentation': 15 technical guides
- 'documentation': 15 technical guides
- 'tutorials': 9 hands-on tutorials
```

Expand Down Expand Up @@ -265,7 +265,7 @@ MEILI_MASTER_KEY=your_master_key # Optional: Default API key

1. **Start Meilisearch**:
```bash
docker run -d -p 7700:7700 getmeili/meilisearch:v1.6
docker run -d -p 7700:7700 getmeili/meilisearch:v1.28
```

2. **Install Development Dependencies**:
Expand Down Expand Up @@ -383,20 +383,20 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
1. **Start Meilisearch server**:
```bash
# Using Docker (recommended for development)
docker run -d -p 7700:7700 getmeili/meilisearch:v1.6
docker run -d -p 7700:7700 getmeili/meilisearch:v1.28

# Or using brew (macOS)
brew install meilisearch
meilisearch

# Or download from https://github.com/meilisearch/meilisearch/releases
```

2. **Install development tools**:
```bash
# Install uv for Python package management
pip install uv

# Install Node.js for MCP Inspector testing
# Visit https://nodejs.org/ or use your package manager
```
Expand Down Expand Up @@ -526,7 +526,7 @@ gh pr create --title "Release v0.5.0" --body "Bump version for release"
Once the PR is approved and merged to `main`, the GitHub Action will automatically:

1. Detect the version change
2. Build the package
2. Build the package
3. Publish to PyPI at https://pypi.org/p/meilisearch-mcp
4. Make the new version available via `pip install meilisearch-mcp`

Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ version = "0.6.0"
description = "MCP server for Meilisearch"
requires-python = ">=3.10"
dependencies = [
"meilisearch>=0.37.0",
"mcp>=1.12.4",
"meilisearch>=0.38.0",
"mcp>=1.23.1",
"httpx>=0.28.1",
"pydantic>=2.11.7",
"pydantic>=2.12.5",
]

[build-system]
Expand Down
8 changes: 4 additions & 4 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pytest>=8.4.1
pytest-asyncio>=1.1.0
black>=25.1.0
mcp>=1.12.4
pytest>=9.0.1
pytest-asyncio>=1.3.0
black>=25.11.0
mcp>=1.23.1
Loading