mcp-meilisearch

MCP Meilisearch API-Server

Eine Serverimplementierung des Model Context Protocol (MCP), die mithilfe des StreamableHTTP-Transports eine Brücke zwischen KI-Modellen und der Meilisearch-Suchmaschine schlägt. Dieses Projekt ermöglicht die nahtlose Integration der leistungsstarken Suchfunktionen von Meilisearch in KI-Workflows.

Aktualisierte Übersicht

Dieses Projekt bietet einen MCP-Server, der KI-Modellen die direkte Interaktion mit Meilisearch-Funktionen ermöglicht. Die Architektur umfasst:

MCP-Server : Stellt Meilisearch-APIs als Tools bereit, die das Model Context Protocol verwenden.
Webclient-Demo : Eine Demo-Oberfläche, die Suchfunktionen vorführt.

Hauptmerkmale

StreamableHTTP-Transport : Echtzeitkommunikation zwischen Clients und Server.
Meilisearch-API-Support : Vollständiger Zugriff auf die Meilisearch-Funktionen.
Verbesserte Fehlerbehandlung : Verbessertes Fehlermanagement für API-Anfragen.
Webclient-Demo : Aktualisierte Schnittstelle zur Demonstration der Suchfunktionen.

Werkzeugkategorien

Der MCP-Server organisiert Meilisearch-APIs in diese Kategorien:

Systemtools : Integritätsprüfungen, Versionsinformationen, Serverstatistiken.
Index-Tools : Indizes verwalten (erstellen, aktualisieren, löschen, auflisten).
Dokumenttools : Dokumente hinzufügen, aktualisieren, löschen und abrufen.
Suchwerkzeuge : Erweiterte Suche, einschließlich Vektorsuche.
Einstellungstools : Indexeinstellungen konfigurieren.
Aufgabentools : Verwalten asynchroner Aufgaben.
Vektor-Tools : Experimentelle Vektorsuchfunktionen.

Erste Schritte

Voraussetzungen

Node.js v20 oder höher.
Eine laufende Meilisearch-Instanz (lokal oder remote).
API-Schlüssel für Meilisearch (falls erforderlich).

Installationsanweisungen

Klonen Sie das Repository:

git clone <repository-url>

Installieren Sie Abhängigkeiten:

npm install

Konfigurieren Sie die Umgebung:

Erstellen Sie eine .env -Datei mit folgendem Inhalt:

MEILISEARCH_HOST=http://localhost:7700
MEILISEARCH_API_KEY=your_master_key_here

Ausführen des Servers

So starten Sie den Server:

npm run server  # Start the MCP server
npm run demo  # Start the Web client demo

Zugriff auf die Weboberfläche

Besuchen Sie die folgende URL in Ihrem Browser:

http://localhost:8080

Entwicklung

Dieses Projekt verwendet:

TypeScript : Gewährleistet die Typsicherheit.
Express : Betreibt den Webserver.
Model Context Protocol SDK : Erleichtert die KI-Integration.

Optionen

Meilisearch-Verbindungsoptionen

meilisearchHost : URL der Meilisearch-Instanz (Standard: " http://localhost:7700 ")
meilisearchApiKey : API-Schlüssel zur Authentifizierung bei Meilisearch (Standard: "")

MCP-Serveroptionen

transport : Transporttyp für MCP-Server ("http" | "stdio") (Standard: "http")
httpPort : HTTP-Port für MCP-Server (Standard: 8080)
mcpEndpoint : MCP-Endpunktpfad (Standard: "/mcp")

Sitzungsoptionen

sessionTimeout : Sitzungstimeout in Millisekunden (Standard: 3600000)
sessionCleanupInterval : Sitzungsbereinigungsintervall in Millisekunden (Standard: 60000)

Verwenden des MCPClient

Das Paket exportiert auch die MCPClient-Klasse für die clientseitige Integration:

import { MCPClient } from "mcp-meilisearch/client";

const client = new MCPClient("mcp-meilisearch-client");
await client.connectToServer("http://localhost:3000/mcp");

// Call a tool
const result = await client.callTool("search-across-all-indexes", {
  q: "search kiosco antonio",
});

mcp-meilisearch

Integrations