Redis MCP Server

Official

hybrid server

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

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 服务器

概述

Redis MCP 服务器是一个自然语言接口,专为代理应用程序设计,用于高效地管理和搜索 Redis 中的数据。它与MCP(模型内容协议)客户端无缝集成,使 AI 驱动的工作流能够与 Redis 中的结构化和非结构化数据进行交互。使用此 MCP 服务器,您可以提出以下问题:

  • “将整个对话存储在流中”
  • “缓存此项目”
  • “存储带有过期时间的会话”
  • “索引并搜索此向量”

特征

  • 自然语言查询:使 AI 代理能够使用自然语言查询和更新 Redis。
  • 无缝 MCP 集成:与任何MCP 客户端配合使用,实现顺畅的通信。
  • 完全支持 Redis :处理哈希、列表、集合、有序集、流等。
  • 搜索和过滤:支持在 Redis 中高效检索和搜索数据。
  • 可扩展且轻量级:专为高性能数据操作而设计。

工具

该 MCP 服务器提供工具来管理存储在 Redis 中的数据。

  • 用于设置、获取带过期时间的string工具。适用于存储简单的配置值、会话数据或缓存响应。
  • hash工具用于在单个键中存储字段值对。哈希可以存储向量嵌入。适用于表示具有多个属性的对象、用户资料或产品信息,其中字段可以单独访问。
  • list工具,包含常用的追加和弹出操作。适用于队列、消息代理或维护最近操作的列表。
  • set工具用于添加、移除和列出集合成员。可用于追踪用户 ID 或标签等唯一值,以及执行诸如交集之类的集合运算。
  • sorted set工具用于管理数据,例如排行榜、优先级队列或基于分数排序的基于时间的分析。
  • pub/sub功能,用于将消息发布到频道并订阅接收消息。适用于实时通知、聊天应用或向多个客户端分发更新。
  • 用于添加、读取和删除数据流streams工具。适用于事件溯源、活动源或传感器数据记录,并支持消费者群组。
  • 用于在 Redis 中存储、检索和操作 JSON 文档的JSON工具。适用于复杂的嵌套数据结构、文档数据库或基于路径访问的配置管理。

附加工具。

  • query engine工具来管理向量索引和执行向量搜索
  • server management工具来检索有关数据库的信息

安装

通过 Smithery 安装

要通过Smithery自动为 Claude Desktop 安装 Redis MCP 服务器:

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

手动安装

# 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

配置

要配置此 Redis MCP 服务器,请考虑以下环境变量:

姓名描述默认值
REDIS_HOSTRedis IP 或主机名"127.0.0.1"
REDIS_PORTRedis 端口6379
REDIS_USERNAME默认数据库用户名"default"
REDIS_PWD默认数据库密码“”
REDIS_SSL启用或禁用 SSL/TLSFalse
REDIS_CA_PATH用于验证服务器的CA证书没有任何
REDIS_SSL_KEYFILE用于客户端身份验证的客户端私钥文件没有任何
REDIS_SSL_CERTFILE用于客户端身份验证的客户端证书文件没有任何
REDIS_CERT_REQS客户端是否应该验证服务器的证书"required"
REDIS_CA_CERTS受信任 CA 证书文件的路径没有任何
REDIS_CLUSTER_MODE启用 Redis 集群模式False

与 OpenAI Agents SDK 集成

将此 MCP 服务器与 OpenAI Agents SDK 集成。阅读文档,了解更多关于 SDK 与 MCP 集成的信息。

安装 Python SDK。

pip install openai-agents

配置 OpenAI 令牌:

export OPENAI_API_KEY="<openai_token>"

并运行该应用程序

python3.13 redis_assistant.py

您可以使用OpenAI 仪表板排除代理工作流程的故障。

与 Claude Desktop 集成

您可以配置 Claude Desktop 来使用此 MCP 服务器。

  1. 指定您的 Redis 凭据和 TLS 配置
  2. 检索您的uv命令完整路径(例如which uv
  3. 编辑claude_desktop_config.json配置文件
    • 在 MacOS 上,位于~/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_PSW": "<your_redis_database_password>", "REDIS_SSL": True|False, "REDIS_CA_PATH": "<your_redis_ca_path>", "REDIS_CLUSTER_MODE": True|False } } } }

您可以通过跟踪日志文件来解决问题。

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

测试

您可以使用MCP Inspector对此 MCP 服务器进行可视化调试。

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

示例用例

  • AI 助手:使 LLM 能够获取、存储和处理 Redis 中的数据。
  • 聊天机器人和虚拟代理:检索会话数据、管理队列和个性化响应。
  • 数据搜索和分析:查询 Redis 以获得实时洞察和快速查找
  • 事件处理:使用Redis Streams管理事件流。

贡献

  1. 复制仓库
  2. 创建新分支( feature-branch
  3. 提交你的更改
  4. 推送到您的分支并提交 PR!

执照

该项目已获得MIT 许可

接触

如有疑问或需要支持,请通过GitHub Issues联系。

You must be authenticated.

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

官方的 Redis MCP Server 是一个为代理应用程序设计的自然语言界面,用于高效地管理和搜索 Redis 中的数据。

  1. Overview
    1. Features
      1. Tools
        1. Installation
          1. Installing via Smithery
          2. Manual Installation
        2. Configuration
          1. Integration with OpenAI Agents SDK
            1. Integration with Claude Desktop
              1. Testing
                1. Example Use Cases
                  1. Contributing
                    1. License
                      1. Contact
                        ID: xa6dw61b8x