Redis MCP Server

Official
by redis

Integrations

  • Integrates with OpenAI Agents SDK, allowing OpenAI-based applications to manage and query Redis data through natural language commands.

  • Provides comprehensive Redis database management through natural language, supporting strings, hashes, lists, sets, sorted sets, streams, JSON documents, vector search, and pub/sub functionality.

Redis MCP Server

Überblick

Der Redis MCP Server ist eine natürlichsprachliche Schnittstelle für agentenbasierte Anwendungen zur effizienten Verwaltung und Suche von Daten in Redis. Er lässt sich nahtlos in MCP-Clients (Model Content Protocol) integrieren und ermöglicht KI-gesteuerten Workflows die Interaktion mit strukturierten und unstrukturierten Daten in Redis. Mit diesem MCP Server können Sie Fragen stellen wie:

  • „Speichern Sie die gesamte Konversation in einem Stream“
  • „Diesen Artikel zwischenspeichern“
  • „Speichern Sie die Sitzung mit einer Ablaufzeit“
  • "Diesen Vektor indizieren und durchsuchen"

Merkmale

  • Abfragen in natürlicher Sprache : Ermöglicht KI-Agenten, Redis in natürlicher Sprache abzufragen und zu aktualisieren.
  • Nahtlose MCP-Integration : Funktioniert mit jedem MCP-Client für reibungslose Kommunikation.
  • Vollständige Redis-Unterstützung : Verarbeitet Hashes, Listen, Sets, sortierte Sets, Streams und mehr.
  • Suchen und Filtern : Unterstützt effizientes Abrufen und Suchen von Daten in Redis.
  • Skalierbar und leichtgewichtig : Entwickelt für leistungsstarke Datenoperationen.

Werkzeuge

Dieser MCP-Server bietet Tools zum Verwalten der in Redis gespeicherten Daten.

  • string -Tools zum Festlegen und Abrufen von Strings mit Ablaufdatum. Nützlich zum Speichern einfacher Konfigurationswerte, Sitzungsdaten oder zum Zwischenspeichern von Antworten.
  • hash -Tools zum Speichern von Feld-Wert-Paaren in einem einzigen Schlüssel. Der Hash kann Vektoreinbettungen speichern. Nützlich für die Darstellung von Objekten mit mehreren Attributen, Benutzerprofilen oder Produktinformationen, bei denen auf die Felder einzeln zugegriffen werden kann.
  • list mit allgemeinen Operationen zum Anhängen und Entfernen von Elementen. Nützlich für Warteschlangen, Nachrichtenbroker oder die Pflege einer Liste der letzten Aktionen.
  • set -Tools zum Hinzufügen, Entfernen und Auflisten von Set-Mitgliedern. Nützlich zum Verfolgen eindeutiger Werte wie Benutzer-IDs oder Tags und zum Ausführen von Set-Operationen wie Schnittmengen.
  • sorted set -Tools zum Verwalten von Daten, z. B. für Bestenlisten, Prioritätswarteschlangen oder zeitbasierte Analysen mit punktbasierter Sortierung.
  • pub/sub -Funktionalität zum Veröffentlichen von Nachrichten in Kanälen und Abonnieren des Empfangs. Nützlich für Echtzeitbenachrichtigungen, Chat-Anwendungen oder die Verteilung von Updates an mehrere Clients.
  • streams -Tools zum Hinzufügen, Lesen und Löschen von Datenströmen. Nützlich für Event Sourcing, Aktivitäts-Feeds oder Sensordatenprotokollierung mit Unterstützung für Verbrauchergruppen.
  • JSON Tools zum Speichern, Abrufen und Bearbeiten von JSON-Dokumenten in Redis. Nützlich für komplexe verschachtelte Datenstrukturen, Dokumentdatenbanken oder Konfigurationsmanagement mit pfadbasiertem Zugriff.

Zusätzliche Werkzeuge.

  • query engine Tools zum Verwalten von Vektorindizes und Durchführen einer Vektorsuche
  • server management zum Abrufen von Informationen über die Datenbank

Installation

Befolgen Sie diese Anweisungen, um den Server zu installieren.

# Clone the repository git clone https://github.com/redis/mcp-redis.git cd mcp-redis # Install dependencies using uv uv venv source .venv/bin/activate uv sync

Konfiguration

Berücksichtigen Sie beim Konfigurieren dieses Redis MCP-Servers die folgenden Umgebungsvariablen:

NameBeschreibungStandardwert
REDIS_HOSTRedis-IP oder Hostname"127.0.0.1"
REDIS_PORTRedis-Port6379
REDIS_USERNAMEStandard-Datenbankbenutzername"default"
REDIS_PWDStandard-Datenbankkennwort""
REDIS_SSLAktiviert oder deaktiviert SSL/TLSFalse
REDIS_CA_PATHCA-Zertifikat zur ServerüberprüfungKeiner
REDIS_SSL_KEYFILEPrivate Schlüsseldatei des Clients zur Client-AuthentifizierungKeiner
REDIS_SSL_CERTFILEZertifikatsdatei des Clients zur Client-AuthentifizierungKeiner
REDIS_CERT_REQSOb der Client das Zertifikat des Servers überprüfen soll"required"
REDIS_CA_CERTSPfad zur Datei mit den vertrauenswürdigen CA-ZertifikatenKeiner
REDIS_CLUSTER_MODEAktivieren Sie den Redis-ClustermodusFalse

Integration mit OpenAI Agents SDK

Integrieren Sie diesen MCP-Server mit dem OpenAI Agents SDK. Lesen Sie die Dokumente , um mehr über die Integration des SDK mit MCP zu erfahren.

Installieren Sie das Python SDK.

pip install openai-agents

Konfigurieren Sie das OpenAI-Token:

export OPENAI_API_KEY="<openai_token>"

Und führen Sie die Anwendung aus.

python3.13 redis_assistant.py

Sie können Probleme mit Ihren Agent-Workflows mithilfe des OpenAI-Dashboards beheben.

Integration mit Claude Desktop

Über Smithery

Wenn Sie den von Smithery bereitgestellten Redis MCP-Server testen möchten, können Sie Claude Desktop automatisch konfigurieren:

npx -y @smithery/cli install @redis/mcp-redis --client claude

Folgen Sie der Eingabeaufforderung und geben Sie die Details zur Serverkonfiguration und zur Verbindung mit Redis ein (z. B. über eine Redis Cloud-Datenbank). Das Verfahren erstellt die entsprechende Konfiguration in der Konfigurationsdatei claude_desktop_config.json .

Manuelle Konfiguration

Sie können Claude Desktop so konfigurieren, dass dieser MCP-Server verwendet wird.

  1. Geben Sie Ihre Redis-Anmeldeinformationen und TLS-Konfiguration an
  2. Rufen Sie den vollständigen Pfad Ihres uv -Befehls ab (z. B. which uv “)
  3. Bearbeiten Sie die Konfigurationsdatei claude_desktop_config.json
    • auf einem MacOS unter ~/Library/Application\ Support/Claude/
{ "mcpServers": { "redis": { "command": "<full_path_uv_command>", "args": [ "--directory", "<your_mcp_server_directory>", "run", "src/main.py" ], "env": { "REDIS_HOST": "<your_redis_database_hostname>", "REDIS_PORT": "<your_redis_database_port>", "REDIS_PWD": "<your_redis_database_password>", "REDIS_SSL": True|False, "REDIS_CA_PATH": "<your_redis_ca_path>", "REDIS_CLUSTER_MODE": True|False } } } }

Verwendung mit Docker

Sie können eine Docker-Bereitstellung dieses Servers verwenden. Sie können entweder Ihr eigenes Image erstellen oder das offizielle Redis MCP Docker -Image verwenden.

Wenn Sie Ihr eigenes Image erstellen möchten, stellt der Redis MCP Server eine Docker-Datei bereit. Erstellen Sie das Image dieses Servers mit:

docker build -t mcp-redis .

Konfigurieren Sie abschließend Claude Desktop so, dass der Container beim Start erstellt wird. Bearbeiten Sie die Datei claude_desktop_config.json und fügen Sie Folgendes hinzu:

{ "mcpServers": { "redis": { "command": "docker", "args": ["run", "--rm", "--name", "redis-mcp-server", "-i", "-e", "REDIS_HOST=<redis_hostname>", "-e", "REDIS_PORT=<redis_port>", "-e", "REDIS_USERNAME=<redis_username>", "-e", "REDIS_PWD=<redis_password>", "mcp-redis"] } } }

Um das offizielle Redis MCP Docker- Image zu verwenden, ersetzen Sie einfach Ihren Image-Namen ( mcp-redis im obigen Beispiel) durch mcp/redis .

Fehlerbehebung

Sie können Probleme beheben, indem Sie die Protokolldatei verfolgen.

tail -f ~/Library/Logs/Claude/mcp-server-redis.log

Integration mit VS Code

Um den Redis MCP-Server mit VS Code zu verwenden, benötigen Sie:

  1. Aktivieren Sie die Agentenmodus -Tools. Fügen Sie Ihrer settings.json Folgendes hinzu:
{ "chat.agent.enabled": true }
  1. Fügen Sie die Redis MCP-Serverkonfiguration zu Ihrer mcp.json oder settings.json hinzu:
// Example .vscode/mcp.json { "servers": { "redis": { "type": "stdio", "command": "<full_path_uv_command>", "args": [ "--directory", "<your_mcp_server_directory>", "run", "src/main.py" ], "env": { "REDIS_HOST": "<your_redis_database_hostname>", "REDIS_PORT": "<your_redis_database_port>", "REDIS_USERNAME": "<your_redis_database_username>", "REDIS_PWD": "<your_redis_database_password>", } } } }
// Example settings.json { "mcp": { "servers": { "redis": { "type": "stdio", "command": "<full_path_uv_command>", "args": [ "--directory", "<your_mcp_server_directory>", "run", "src/main.py" ], "env": { "REDIS_HOST": "<your_redis_database_hostname>", "REDIS_PORT": "<your_redis_database_port>", "REDIS_USERNAME": "<your_redis_database_username>", "REDIS_PWD": "<your_redis_database_password>", } } } } }

Weitere Informationen finden Sie in der VS Code-Dokumentation .

Testen

Sie können den MCP Inspector zum visuellen Debuggen dieses MCP-Servers verwenden.

npx @modelcontextprotocol/inspector uv run src/main.py

Beispiel-Anwendungsfälle

  • KI-Assistenten : Ermöglichen Sie LLMs, Daten in Redis abzurufen, zu speichern und zu verarbeiten.
  • Chatbots und virtuelle Agenten : Rufen Sie Sitzungsdaten ab, verwalten Sie Warteschlangen und personalisieren Sie Antworten.
  • Datensuche und -analyse : Abfrage von Redis für Echtzeit-Einblicke und schnelle Nachschlagevorgänge .
  • Ereignisverarbeitung : Verwalten Sie Ereignisströme mit Redis Streams .

Beitragen

  1. Forken Sie das Repo
  2. Erstellen Sie einen neuen Zweig ( feature-branch ).
  3. Übernehmen Sie Ihre Änderungen
  4. Pushen Sie zu Ihrem Zweig und senden Sie einen PR!

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.

Kontakt

Bei Fragen oder für Support wenden Sie sich bitte über GitHub Issues an uns .

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Der offizielle Redis MCP-Server ist eine natürliche Sprachschnittstelle, die für Agentenanwendungen entwickelt wurde, um Daten in Redis effizient zu verwalten und zu suchen.

  1. Überblick
    1. Merkmale
      1. Werkzeuge
        1. Installation
          1. Konfiguration
            1. Integration mit OpenAI Agents SDK
              1. Integration mit Claude Desktop
                1. Über Smithery
                2. Manuelle Konfiguration
                3. Verwendung mit Docker
                4. Fehlerbehebung
              2. Integration mit VS Code
                1. Testen
                  1. Beispiel-Anwendungsfälle
                    1. Beitragen
                      1. Lizenz
                        1. Kontakt

                          Related MCP Servers

                          • A
                            security
                            A
                            license
                            A
                            quality
                            Enables users to perform Redis database operations using the Model Context Protocol (MCP) tools, allowing for efficient data management through commands like setting, getting, and scanning hash fields.
                            Last updated -
                            13
                            29
                            5
                            TypeScript
                            MIT License
                          • A
                            security
                            F
                            license
                            A
                            quality
                            Model Context Protocol (MCP) server that integrates Redash with AI assistants like Claude, allowing them to query data, manage visualizations, and interact with dashboards through natural language.
                            Last updated -
                            10
                            53
                            16
                            JavaScript
                            • Apple
                          • -
                            security
                            F
                            license
                            -
                            quality
                            A custom MCP server that allows storage, retrieval, and management of text-based information with natural language commands and keyword detection.
                            Last updated -
                            TypeScript
                            • Linux
                            • Apple
                          • -
                            security
                            F
                            license
                            -
                            quality
                            An MCP server that connects AI assistants to SearchAgora, enabling users to search for, discover, and purchase products across the web through natural language conversations.
                            Last updated -
                            Python
                            • Apple

                          View all related MCP servers

                          ID: xa6dw61b8x