Meilisearch MCP Server

• 現在の接続設定の表示
• Meilisearchインスタンスの動的切り替え
• APIキーのその場での更新

• カスタムプライマリキーを持つ新しいインデックスの作成
• 統計情報付きの全インデックス一覧表示
• インデックスとそのデータの削除
• 詳細なインデックスメトリクスの取得

• ドキュメントの追加または更新
• ページネーション付きのドキュメント取得
• データの一括インポート

• フィルター、ソート、ファセットを使った検索
• マルチインデックス検索
• ベクトルによるセマンティック検索
• ハイブリッド検索（キーワード + セマンティック）

• ランキングルールの設定
• ファセットとフィルタリングの設定
• 検索可能属性の管理
• タイポトレランスのカスタマイズ

• APIキーの作成と管理
• きめ細かな権限の設定
• キー使用状況の監視

⚠️ 注意：チャットで直接ホストやAPIキーを追加・更新できるのは便利ですが、このアプローチは主に開発用途（複数インスタンスへのその場での接続など）向けに設計されています。MCPのセキュリティベストプラクティスに従っておらず、適切な保護なしに本番環境で使用すべきではありません。

• ヘルスチェック
• システム統計
• タスク監視
• バージョン情報

利用可能なツール

接続管理

• get-connection-settings: 現在のMeilisearch接続URLとAPIキーの状態を表示
• update-connection-settings: URLやAPIキーを更新して別のインスタンスに接続

インデックス管理

• create-index: オプションのプライマリキーで新しいインデックスを作成
• list-indexes: 利用可能なすべてのインデックスを一覧表示
• delete-index: 既存のインデックスとそのすべてのドキュメントを削除
• get-index-metrics: 特定のインデックスの詳細なメトリクスを取得

ドキュメント操作

• get-documents: ページネーション付きでインデックスからドキュメントを取得
• add-documents: インデックスにドキュメントを追加または更新

検索

• search: フィルタリングとソートオプションを使用した、単一または複数のインデックスにわたる柔軟な検索

設定管理

• get-settings: インデックスの現在の設定を表示
• update-settings: インデックス設定を更新（ランキング、ファセットなど）

APIキー管理

• get-keys: すべてのAPIキーを一覧表示
• create-key: 特定の権限を持つ新しいAPIキーを作成
• delete-key: 既存のAPIキーを削除

タスク管理

• get-task: 特定のタスクに関する情報を取得
• get-tasks: オプションのフィルターでタスクを一覧表示
• cancel-tasks: 保留中またはキューに入っているタスクをキャンセル
• delete-tasks: 完了したタスクを削除

システム監視

• health-check: 基本的なヘルスチェック
• get-health-status: 包括的なヘルスステータス
• get-version: Meilisearchのバージョン情報を取得
• get-stats: データベース統計を取得
• get-system-info: システムレベルの情報を取得

開発セットアップ

前提条件

1. Meilisearchサーバーの起動：

   # Using Docker (recommended for development)
   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 uv for Python package management
   pip install uv
   
   # Install Node.js for MCP Inspector testing
   # Visit https://nodejs.org/ or use your package manager
   

テストの実行

このプロジェクトには、MCPツールの機能を検証する包括的な統合テストが含まれています：

# Run all tests
python -m pytest tests/ -v

# Run specific test file
python -m pytest tests/test_mcp_client.py -v

# Run tests with coverage report
python -m pytest --cov=src tests/

# Run tests in watch mode (requires pytest-watch)
pytest-watch tests/

重要：テストには http://localhost:7700 で稼働中のMeilisearchインスタンスが必要です。

コード品質

# Format code with Black
black src/ tests/

# Run type checking (if mypy is configured)
mypy src/

# Lint code (if flake8 is configured)
flake8 src/ tests/

コントリビューションガイドライン

1. リポジトリをフォークしてクローン
2. 上記の開発セットアップセクションに従って開発環境をセットアップ
3. main からフィーチャーブランチを作成
4. 新しい機能を追加する場合は、最初にテストを作成（テスト駆動開発）
5. コミット前にローカルでテストを実行し、すべてのテストがパスすることを確認
6. Blackでコードをフォーマットし、コード品質を確保
7. 説明的なコミットメッセージで変更をコミット
8. フォークにプッシュしてプルリクエストを作成

開発ワークフロー

# Create feature branch
git checkout -b feature/your-feature-name

# Make your changes, write tests first
# Edit files...

# Run tests to ensure everything works
python -m pytest tests/ -v

# Format code
black src/ tests/

# Commit and push
git add .
git commit -m "Add feature description"
git push origin feature/your-feature-name

テストガイドライン

• すべての新機能にはテストを含める必要があります
• PRを提出する前にテストがパスする必要があります
• 説明的なテスト名と明確なアサーションを使用してください
• 成功ケースとエラーケースの両方をテストしてください
• テストを実行する前にMeilisearchが稼働していることを確認してください

リリースプロセス

このプロジェクトは、PyPIへの自動バージョニングと公開を使用しています。リリースプロセスはシンプルで自動化されるように設計されています。

リリースの仕組み

1. 自動公開: pyproject.toml のバージョン番号が main ブランチで変更されると、GitHub Actionが自動的に：

   • Pythonパッケージをビルド
   • 信頼できる公開を使用してPyPIに公開
   • GitHubで新しいリリースを作成

2. バージョン検出: ワークフローは、pyproject.toml の現在のバージョンを前のコミットと比較して変更を検出します

3. PyPI公開: PyPAの公式公開アクションを信頼できる公開で使用（手動のAPIキーは不要）

新しいリリースの作成

新しいリリースを作成するには、以下の手順に従ってください：

1. バージョン番号の決定

セマンティックバージョニング（MAJOR.MINOR.PATCH）に従います：

• PATCH（例：0.4.0 → 0.4.1）：バグ修正、ドキュメント更新、軽微な改善
• MINOR（例：0.4.0 → 0.5.0）：新機能、新しいMCPツール、重要な機能強化
• MAJOR（例：0.5.0 → 1.0.0）：破壊的変更、メジャーなAPI変更

2. バージョンを更新してPRを作成

# 1. Create a branch from latest main
git checkout main
git pull origin main
git checkout -b release/v0.5.0

# 2. Update version in pyproject.toml
# Edit the version = "0.4.0" line to your new version

# 3. Commit and push
git add pyproject.toml
git commit -m "Bump version to 0.5.0"
git push origin release/v0.5.0

# 4. Create PR and get it reviewed/merged
gh pr create --title "Release v0.5.0" --body "Bump version for release"

3. メインにマージ

PRが承認され main にマージされると、GitHub Actionが自動的に：

1. バージョン変更を検出
2. パッケージをビルド
3. https://pypi.org/p/meilisearch-mcp のPyPIに公開
4. pip install meilisearch-mcp 経由で新しいバージョンを利用可能にします

4. リリースの確認

マージ後、リリースを確認します：

# Check GitHub Action status
gh run list --workflow=publish.yml

# Verify on PyPI (may take a few minutes)
pip index versions meilisearch-mcp

# Test installation of new version
pip install --upgrade meilisearch-mcp

リリースワークフローファイル

自動リリースは .github/workflows/publish.yml によって処理され、以下を行います：

• main ブランチへのプッシュでトリガー
• pyproject.toml のバージョンが変更されたかどうかを確認
• Python 3.10と公式ビルドツールを使用
• 信頼できる公開を使用して公開（APIキー不要）
• デバッグ用の詳細出力を提供

リリースのトラブルシューティング

リリースがトリガーされなかった: pyproject.toml のバージョンがコミット間で実際に変更されたか確認してください

ビルドが失敗した: GitHub ActionsのログでPythonパッケージビルドエラーを確認してください

PyPI公開が失敗した: パッケージ名と信頼できる公開が正しく構成されているか確認してください バージョンの競合: 新しいバージョン番号がPyPIで以前に使用されていないことを確認してください

開発版と製品版

• 開発版: ソースからインストールするには pip install -e . を使用します
• 製品版: PyPIからインストールするには pip install meilisearch-mcp を使用します
• 特定のバージョン: インストールするには pip install meilisearch-mcp==0.5.0 を使用します