Meilisearch

• Aktuelle Verbindungseinstellungen anzeigen
• Dynamisch zwischen Meilisearch-Instanzen wechseln
• API-Schlüssel spontan aktualisieren

• Neue Indizes mit benutzerdefinierten Primärschlüsseln erstellen
• Alle Indizes mit Statistiken auflisten
• Indizes und ihre Daten löschen
• Detaillierte Indexmetriken abrufen

• Dokumente hinzufügen oder aktualisieren
• Dokumente mit Paginierung abrufen
• Daten gesammelt importieren

• Mit Filtern, Sortierung und Facetten suchen
• Suche über mehrere Indizes
• Semantische Suche mit Vektoren
• Hybridsuche (Schlüsselwort + semantisch)

• Ranking-Regeln konfigurieren
• Facettierung und Filterung einrichten
• Durchsuchbare Attribute verwalten
• Fehlertoleranz anpassen

• API-Schlüssel erstellen und verwalten
• Detaillierte Berechtigungen festlegen
• Schlüsselnutzung überwachen

⚠️ Hinweis: Sie können Hosts und API-Schlüssel bequem direkt im Chat hinzufügen und aktualisieren. Dieser Ansatz ist jedoch in erster Linie für Entwicklungsfälle gedacht (z. B. für die spontane Verbindung mit mehreren Instanzen). Er entspricht nicht den bewährten MCP-Sicherheitspraktiken und sollte ohne geeignete Schutzmaßnahmen nicht in Produktionsumgebungen verwendet werden.

• Zustandsprüfungen
• Systemstatistiken
• Aufgabenüberwachung
• Versionsinformationen

Verfügbare Tools

Verbindungsverwaltung

• get-connection-settings: Aktuelle Meilisearch-Verbindungs-URL und Status des API-Schlüssels anzeigen
• update-connection-settings: URL und/oder API-Schlüssel aktualisieren, um eine Verbindung zu einer anderen Instanz herzustellen

Indexverwaltung

• create-index: Einen neuen Index mit optionalem Primärschlüssel erstellen
• list-indexes: Alle verfügbaren Indizes auflisten
• delete-index: Einen vorhandenen Index und alle seine Dokumente löschen
• get-index-metrics: Detaillierte Metriken für einen bestimmten Index abrufen

Dokumentvorgänge

• get-documents: Dokumente mit Paginierung aus einem Index abrufen
• add-documents: Dokumente zu einem Index hinzufügen oder aktualisieren

Suche

• search: Flexible Suche in einem oder mehreren Indizes mit Filter- und Sortieroptionen

Einstellungsverwaltung

• get-settings: Aktuelle Einstellungen für einen Index anzeigen
• update-settings: Indexeinstellungen aktualisieren (Ranking, Facettierung usw.)

API-Schlüsselverwaltung

• get-keys: Alle API-Schlüssel auflisten
• create-key: Einen neuen API-Schlüssel mit bestimmten Berechtigungen erstellen
• delete-key: Einen vorhandenen API-Schlüssel löschen

Aufgabenverwaltung

• get-task: Informationen zu einer bestimmten Aufgabe abrufen
• get-tasks: Aufgaben mit optionalen Filtern auflisten
• cancel-tasks: Ausstehende oder eingereihte Aufgaben abbrechen

Systemüberwachung

• health-check: Einfache Zustandsprüfung
• get-health-status: Umfassenden Zustandsstatus abrufen
• get-version: Versionsinformationen zu Meilisearch abrufen
• get-stats: Datenbankstatistiken abrufen
• get-system-info: Informationen auf Systemebene abrufen

Entwicklungsumgebung einrichten

Voraussetzungen

1. Meilisearch-Server starten:

   # 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. Entwicklungstools installieren:

   # 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
   

Tests ausführen

Dieses Projekt enthält umfassende Integrationstests, die die Funktionalität der MCP-Tools überprüfen:

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

Wichtig: Für die Tests muss eine Meilisearch-Instanz unter http://localhost:7700 laufen.

Codequalität

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

Richtlinien für Beiträge

1. Repository forken und klonen
2. Entwicklungsumgebung einrichten – Folgen Sie dazu dem obigen Abschnitt „Entwicklungsumgebung einrichten“
3. Feature-Branch erstellen – ausgehend von main
4. Zuerst Tests schreiben, wenn Sie neue Funktionen hinzufügen (testgetriebene Entwicklung)
5. Tests lokal ausführen, um vor dem Commit sicherzustellen, dass alle Tests bestehen
6. Code formatieren mit Black und die Codequalität sicherstellen
7. Änderungen committen und aussagekräftige Commit-Nachrichten verwenden
8. Änderungen in Ihren Fork pushen und einen Pull Request erstellen

Entwicklungsablauf

# 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

Testrichtlinien

• Alle neuen Funktionen sollten Tests enthalten
• Tests müssen vor dem Einreichen eines PRs bestehen
• Aussagekräftige Testnamen und klare Assertions verwenden
• Erfolgs- und Fehlerfälle testen
• Vor dem Ausführen der Tests sicherstellen, dass Meilisearch läuft

Veröffentlichungsprozess

Dieses Projekt verwendet automatisierte Versionierung und Veröffentlichung auf PyPI. Der Veröffentlichungsprozess ist einfach und automatisiert.

So funktionieren Veröffentlichungen

1. Automatische Veröffentlichung: Wenn sich die Versionsnummer in pyproject.toml im Branch main ändert, führt eine GitHub Action automatisch Folgendes aus:

   • Erstellt das Python-Paket
   • Veröffentlicht es mithilfe von Trusted Publishing auf PyPI
   • Erstellt eine neue Veröffentlichung auf GitHub

2. Versionserkennung: Der Workflow vergleicht die aktuelle Version in pyproject.toml mit dem vorherigen Commit, um Änderungen zu erkennen

3. Veröffentlichung auf PyPI: Verwendet die offizielle Publish Action von PyPA mit Trusted Publishing (manuelle API-Schlüssel sind nicht erforderlich)

Neue Veröffentlichung erstellen

Gehen Sie wie folgt vor, um eine neue Veröffentlichung zu erstellen:

1. Versionsnummer festlegen

Befolgen Sie Semantic Versioning (MAJOR.MINOR.PATCH):

• PATCH (z. B. 0.4.0 → 0.4.1): Fehlerbehebungen, Dokumentationsaktualisierungen, kleinere Verbesserungen
• MINOR (z. B. 0.4.0 → 0.5.0): Neue Funktionen, neue MCP-Tools, wesentliche Erweiterungen
• MAJOR (z. B. 0.5.0 → 1.0.0): Inkompatible Änderungen, wesentliche API-Änderungen

2. Version aktualisieren und PR erstellen

# 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. In Main mergen

Sobald der PR genehmigt und in main gemergt wurde, führt die GitHub Action automatisch Folgendes aus:

1. Versionsänderung erkennen
2. Paket erstellen
3. Auf PyPI unter https://pypi.org/p/meilisearch-mcp veröffentlichen
4. Die neue Version über pip install meilisearch-mcp verfügbar machen

4. Release überprüfen

Nach dem Zusammenführen das Release überprüfen:

# 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

Release-Workflow-Datei

Das automatisierte Release wird von .github/workflows/publish.yml verwaltet. Dabei wird:

• Bei Pushes auf den Branch main ausgelöst
• Geprüft, ob sich die Version von pyproject.toml geändert hat
• Python 3.10 und offizielle Build-Tools verwendet
• Mit Trusted Publishing veröffentlicht (keine API-Schlüssel erforderlich)
• Eine ausführliche Ausgabe zur Fehlerbehebung bereitgestellt

Fehlerbehebung bei Releases

Release wurde nicht ausgelöst: Prüfen, ob sich die Version in pyproject.toml zwischen den Commits tatsächlich geändert hat

Build fehlgeschlagen: Die GitHub-Actions-Protokolle auf Fehler beim Erstellen des Python-Pakets prüfen

PyPI-Veröffentlichung fehlgeschlagen: Den Paketnamen überprüfen und sicherstellen, dass Trusted Publishing korrekt konfiguriert ist

Versionskonflikte: Sicherstellen, dass die neue Versionsnummer noch nicht auf PyPI verwendet wurde

Entwicklungs- und Produktionsversionen

• Entwicklung: Aus dem Quellcode installieren mit pip install -e .
• Produktion: Von PyPI installieren mit pip install meilisearch-mcp
• Bestimmte Version: Installieren mit pip install meilisearch-mcp==0.5.0