使用说明

项目简介

Redis MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端，旨在使AI agent能够通过自然语言与Redis数据库进行交互。它充当MCP服务器，提供了一系列工具，允许AI agent以自然语言指令操作Redis中的各种数据结构，如字符串、哈希、列表、集合、有序集合、流和JSON文档，并支持向量搜索等高级功能。

主要功能点

自然语言查询: AI agent可以使用自然语言指令操作Redis数据。
MCP 协议集成: 无缝对接任何MCP客户端，实现顺畅通信。
全面的 Redis 支持: 支持 Redis 的各种数据结构，包括 hashes, lists, sets, sorted sets, streams 等。
数据搜索与过滤: 支持高效的数据检索和搜索功能，包括向量相似度搜索。
高扩展性和轻量级: 专为高性能数据操作设计。

安装步骤

克隆仓库

git clone https://github.com/redis/mcp-redis.git
cd mcp-redis

安装依赖 首先确保已安装 uv。然后创建虚拟环境并安装项目依赖：

uv venv
source .venv/bin/activate
uv sync

服务器配置

MCP客户端需要配置Redis MCP服务器的启动命令和参数，以便建立连接。以下是配置信息（JSON格式），请根据您的实际环境修改：

{
    "server name": "redis",  // 服务器名称，可以自定义
    "command": "<uv 命令的完整路径>",  // uv 命令的完整路径，例如 /usr/local/bin/uv，可以使用 'which uv' 命令查找
    "args": [
        "--directory",
        "<mcp-redis 仓库的路径>/src", // mcp-redis 仓库 src 目录的完整路径
        "run",
        "main.py"
    ],
    "env": {
        "REDIS_HOST": "<您的 Redis 数据库主机名>",  // Redis 服务器主机名或IP地址，默认为 127.0.0.1
        "REDIS_PORT": "<您的 Redis 数据库端口>",  // Redis 服务器端口，默认为 6379
        "REDIS_USERNAME": "<您的 Redis 数据库用户名>",  // Redis 数据库用户名，如果需要
        "REDIS_PWD": "<您的 Redis 数据库密码>",     // Redis 数据库密码，如果需要
        "REDIS_SSL": false,                       // 是否启用 SSL/TLS 连接，true 或 false
        "REDIS_CA_PATH": "<您的 Redis CA 证书路径>"   // Redis CA 证书路径，如果启用 SSL/TLS 且需要
    }
}

注意:

'<uv 命令的完整路径>': 请替换为 'uv' 命令在您系统中的完整路径。可以使用 'which uv' 命令查找。
'<mcp-redis 仓库的路径>': 请替换为您克隆 'mcp-redis' 仓库后，本地仓库的绝对路径。
'<您的 Redis 数据库配置>': 请根据您的 Redis 数据库实际配置进行填写，包括主机名、端口、用户名、密码以及 SSL/TLS 相关配置。

基本使用方法

启动服务器: 配置完成后，MCP客户端将根据您提供的配置启动 Redis MCP 服务器。
通过 MCP 客户端与服务器交互: 使用支持 MCP 协议的客户端（如 OpenAI Agents SDK, Claude Desktop 等），配置连接到 Redis MCP 服务器。客户端将发送符合 MCP 协议的请求给服务器。
使用自然语言指令: 在 MCP 客户端中，可以使用自然语言指令，通过 Redis MCP 服务器提供的工具来操作 Redis 数据库。例如，可以使用 'string.set' 工具来设置字符串键值对，使用 'hash.hget' 工具来获取哈希字段的值，等等。

具体工具和使用方法可以参考仓库中 'src/tools' 目录下的各个工具模块的文档和函数签名。

关键词