Meilisearch

• Voir les paramètres de connexion actuels
• Basculer dynamiquement entre les instances Meilisearch
• Mettre à jour les clés API à la volée

• Créer de nouveaux index avec des clés primaires personnalisées
• Lister tous les index avec statistiques
• Supprimer des index et leurs données
• Obtenir des métriques détaillées sur les index

• Ajouter ou mettre à jour des documents
• Récupérer des documents avec pagination
• Importer des données en masse

• Rechercher avec filtres, tri et facettes
• Recherche multi-index
• Recherche sémantique avec vecteurs
• Recherche hybride (mots-clés + sémantique)

• Configurer les règles de classement
• Mettre en place la facettisation et le filtrage
• Gérer les attributs recherchables
• Personnaliser la tolérance aux fautes de frappe

• Créer et gérer des clés API
• Définir des permissions granulaires
• Surveiller l'utilisation des clés

⚠️ Note : Bien que vous puissiez ajouter et mettre à jour des hôtes et des clés API directement dans le chat pour plus de commodité, cette approche est principalement conçue pour des cas d'utilisation de développement (comme la connexion à plusieurs instances à la volée). Elle ne suit pas les meilleures pratiques de sécurité MCP et ne doit pas être utilisée en production sans garde-fous appropriés.

• Vérifications de santé
• Statistiques système
• Suivi des tâches
• Informations de version

Outils disponibles

Gestion des connexions

• get-connection-settings : Voir l'URL de connexion Meilisearch actuelle et le statut de la clé API
• update-connection-settings : Mettre à jour l'URL et/ou la clé API pour se connecter à une autre instance

Gestion des index

• create-index : Créer un nouvel index avec clé primaire optionnelle
• list-indexes : Lister tous les index disponibles
• delete-index : Supprimer un index existant et tous ses documents
• get-index-metrics : Obtenir des métriques détaillées pour un index spécifique

Opérations sur les documents

• get-documents : Récupérer des documents d'un index avec pagination
• add-documents : Ajouter ou mettre à jour des documents dans un index

Recherche

• search : Recherche flexible sur un ou plusieurs index avec options de filtrage et de tri

Gestion des paramètres

• get-settings : Voir les paramètres actuels d'un index
• update-settings : Mettre à jour les paramètres de l'index (classement, facettisation, etc.)

Gestion des clés API

• get-keys : Lister toutes les clés API
• create-key : Créer une nouvelle clé API avec des permissions spécifiques
• delete-key : Supprimer une clé API existante

Gestion des tâches

• get-task : Obtenir des informations sur une tâche spécifique
• get-tasks : Lister les tâches avec filtres optionnels
• cancel-tasks : Annuler les tâches en attente ou en file d'attente

Surveillance du système

• health-check : Vérification de santé de base
• get-health-status : Statut de santé complet
• get-version : Obtenir les informations de version de Meilisearch
• get-stats : Obtenir les statistiques de la base de données
• get-system-info : Obtenir des informations au niveau système

Configuration du développement

Prérequis

1. Démarrez le serveur 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. Installez les outils de développement :

   # 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
   

Exécution des tests

Ce projet comprend des tests d'intégration complets qui vérifient la fonctionnalité des outils 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/

Important : Les tests nécessitent une instance Meilisearch en cours d'exécution sur http://localhost:7700.

Qualité du code

# 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/

Directives de contribution

1. Forkez et clonez le dépôt
2. Configurez l'environnement de développement en suivant la section Configuration du développement ci-dessus
3. Créez une branche de fonctionnalité à partir de main
4. Écrivez d'abord les tests si vous ajoutez de nouvelles fonctionnalités (développement piloté par les tests)
5. Exécutez les tests localement pour vous assurer que tous les tests passent avant de valider
6. Formatez le code avec Black et assurez la qualité du code
7. Validez les modifications avec des messages de validation descriptifs
8. Poussez vers votre fork et créez une pull request

Workflow de développement

# 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

Directives de test

• Toutes les nouvelles fonctionnalités doivent inclure des tests
• Les tests doivent passer avant de soumettre des PR
• Utilisez des noms de tests descriptifs et des assertions claires
• Testez à la fois les cas de succès et d'erreur
• Assurez-vous que Meilisearch est en cours d'exécution avant de lancer les tests

Processus de publication

Ce projet utilise un versionnage et une publication automatisés vers PyPI. Le processus de publication est conçu pour être simple et automatisé.

Comment fonctionnent les publications

1. Publication automatisée : Lorsque le numéro de version dans pyproject.toml change sur la branche main, une GitHub Action automatiquement :

   • Construit le paquet Python
   • Le publie sur PyPI en utilisant la publication de confiance
   • Crée une nouvelle version sur GitHub

2. Détection de version : Le workflow compare la version actuelle dans pyproject.toml avec le commit précédent pour détecter les changements

3. Publication PyPI : Utilise l'action de publication officielle de PyPA avec publication de confiance (pas de clés API manuelles nécessaires)

Créer une nouvelle version

Pour créer une nouvelle version, suivez ces étapes :

1. Déterminez le numéro de version

Suivez le Versionnage sémantique (MAJEUR.MINEUR.CORRECTIF) :

• CORRECTIF (par exemple, 0.4.0 → 0.4.1) : Corrections de bugs, mises à jour de documentation, améliorations mineures
• MINEUR (par exemple, 0.4.0 → 0.5.0) : Nouvelles fonctionnalités, nouveaux outils MCP, améliorations significatives
• MAJEUR (par exemple, 0.5.0 → 1.0.0) : Changements cassants, modifications majeures de l'API

2. Mettez à jour la version et créez une 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. Fusionnez dans la branche principale

Une fois la PR approuvée et fusionnée dans main, la GitHub Action automatiquement :

1. Détecte le changement de version
2. Construit le paquet
3. Publie sur PyPI à https://pypi.org/p/meilisearch-mcp
4. Rend la nouvelle version disponible via pip install meilisearch-mcp

4. Vérifiez la version

Après la fusion, vérifiez la version :

# 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

Fichier de workflow de publication

La publication automatisée est gérée par .github/workflows/publish.yml, qui :

• Se déclenche sur les push vers la branche main
• Vérifie si la version de pyproject.toml a changé
• Utilise Python 3.10 et les outils de construction officiels
• Publie en utilisant la publication de confiance (aucune clé API requise)
• Fournit une sortie détaillée pour le débogage

Dépannage des publications

Le déclenchement de la release n'a pas eu lieu : Vérifiez que la version dans pyproject.toml a réellement changé entre les commits

La construction a échoué : Consultez les journaux GitHub Actions pour les erreurs de construction du package Python

La publication sur PyPI a échoué : Vérifiez le nom du package et que la publication de confiance est correctement configurée

Conflits de versions : Assurez-vous que le nouveau numéro de version n'a pas déjà été utilisé sur PyPI

Versions de développement vs production

• Développement : Installez à partir de la source en utilisant pip install -e .
• Production : Installez depuis PyPI en utilisant pip install meilisearch-mcp
• Version spécifique : Installez en utilisant pip install meilisearch-mcp==0.5.0