Redis MCP 服务器
概述
Redis MCP 服务器是一个自然语言接口,无缝集成,使 AI 驱动的工作流能够与 Redis 中的结构化和非结构化数据进行交互。使用此 MCP 服务器,您可以提出以下问题:
“将整个对话存储在流中”
“缓存此项目”
“存储带有过期时间的会话”
“索引并搜索此向量”
Related MCP server: MCP Server
特征
自然语言查询:使 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工具来检索有关数据库的信息
安装
按照这些说明安装服务器。
# 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 IP 或主机名 |
|
| Redis 端口 |
|
| 默认数据库用户名 |
|
| 默认数据库密码 | “” |
| 启用或禁用 SSL/TLS |
|
| 用于验证服务器的CA证书 | 没有任何 |
| 用于客户端身份验证的客户端私钥文件 | 没有任何 |
| 用于客户端身份验证的客户端证书文件 | 没有任何 |
| 客户端是否应该验证服务器的证书 |
|
| 受信任 CA 证书文件的路径 | 没有任何 |
| 启用 Redis 集群模式 |
|
| 使用 |
|
交通
此 MCP 服务器可配置为本地处理请求,以进程形式运行,并通过stdin和stdout与 MCP 客户端通信。这是默认配置。sse sse也可配置,以便服务器可通过网络访问。请相应地配置MCP_TRANSPORT变量。
export MCP_TRANSPORT="sse"然后启动服务器。
uv run src/main.py测试服务器:
curl -i http://127.0.0.1:8000/sse
HTTP/1.1 200 OK与您喜欢的工具或客户端集成。GitHub Copilot 的 VS Code 配置如下:
"mcp": {
"servers": {
"redis-mcp": {
"type": "sse",
"url": "http://127.0.0.1:8000/sse"
},
}
},与 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 集成
通过史密斯里
如果你想测试Smithery 部署的Redis MCP Server ,你可以自动配置 Claude Desktop:
npx -y @smithery/cli install @redis/mcp-redis --client claude按照提示提供详细信息以配置服务器并连接到 Redis(例如,使用 Redis 云数据库)。该过程将在claude_desktop_config.json配置文件中创建正确的配置。
手动配置
您可以配置 Claude Desktop 来使用此 MCP 服务器。
指定您的 Redis 凭据和 TLS 配置
检索您的
uv命令完整路径(例如which uv)编辑
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_PWD": "<your_redis_database_password>",
"REDIS_SSL": True|False,
"REDIS_CA_PATH": "<your_redis_ca_path>",
"REDIS_CLUSTER_MODE": True|False
}
}
}
}与 Docker 一起使用
您可以使用此服务器的 Docker 化部署。您可以构建自己的镜像,也可以使用官方的Redis MCP Docker镜像。
如果您想构建自己的镜像,Redis MCP 服务器提供了一个 Dockerfile。使用以下命令构建此服务器的镜像:
docker build -t mcp-redis .最后,配置 Claude Desktop 使其在启动时创建容器。编辑claude_desktop_config.json并添加:
{
"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"]
}
}
}要使用官方的Redis MCP Docker镜像,只需将镜像名称(上例中的mcp-redis )替换为mcp/redis 。
故障排除
您可以通过跟踪日志文件来解决问题。
tail -f ~/Library/Logs/Claude/mcp-server-redis.log与 VS Code 集成
要将 Redis MCP 服务器与 VS Code 一起使用,您需要:
启用代理模式工具。将以下内容添加到您的
settings.json中:
{
"chat.agent.enabled": true
}将 Redis MCP 服务器配置添加到你的
mcp.json或settings.json中:
// 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>",
}
}
}
}
}有关更多信息,请参阅VS Code 文档。
测试
您可以使用MCP Inspector对此 MCP 服务器进行可视化调试。
npx @modelcontextprotocol/inspector uv run src/main.py示例用例
AI 助手:使 LLM 能够获取、存储和处理 Redis 中的数据。
聊天机器人和虚拟代理:检索会话数据、管理队列和个性化响应。
数据搜索和分析:查询 Redis 以获得实时洞察和快速查找。
事件处理:使用Redis Streams管理事件流。
贡献
复制仓库
创建新分支(
feature-branch)提交你的更改
推送到您的分支并提交 PR!
执照
该项目已获得MIT 许可。
徽章
接触
如有疑问或需要支持,请通过GitHub Issues联系。