使用说明

项目简介

Redis MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，它允许大型语言模型（LLM）通过标准化的工具集与 Redis 数据库进行交互。该服务器提供了一系列工具，用于在 Redis 中设置、获取、删除和列出键值对，使得 LLM 能够方便地利用 Redis 存储和检索信息。

主要功能点

Redis 数据操作工具: 提供了 'set', 'get', 'delete', 'list' 四个核心工具，允许 LLM 执行基本的 Redis 键值对操作。
- 'set': 设置 Redis 键值对，并支持设置过期时间。
- 'get': 根据键获取 Redis 中存储的值。
- 'delete': 删除 Redis 中的一个或多个键。
- 'list': 根据模式列出 Redis 中的键。
MCP 协议支持: 完全兼容 Model Context Protocol，能够与任何支持 MCP 协议的 LLM 客户端进行无缝集成。
灵活的部署方式: 支持通过 Smithery 自动安装、手动安装以及 Docker 部署，适应不同的使用场景和环境。
标准输入输出通信: 使用 Stdio 作为 MCP 服务器的传输协议，简化部署和配置。

安装步骤

推荐使用 npx 运行 (无需安装):

npx @gongrzhe/[email protected] redis://your-redis-host:port

请将 'redis://your-redis-host:port' 替换为您的 Redis 服务器连接 URL。例如，如果 Redis 服务器运行在本地默认端口，则可以使用 'redis://localhost:6379'。

全局安装 (可选): 如果您希望全局安装以便在任何地方直接运行，可以使用以下命令：

npm install -g @gongrzhe/[email protected]
@gongrzhe/server-redis-mcp redis://your-redis-host:port

同样，请替换为您的 Redis 服务器连接 URL。

服务器配置

要将 Redis MCP Server 与 MCP 客户端（例如 Claude Desktop）配合使用，您需要在客户端的 MCP 服务器配置中添加相应的条目。以下是 Claude Desktop 客户端 'claude_desktop_config.json' 文件的配置示例：

{
  "mcpServers": {
    "redis": {
      "command": "npx",
      "args": [
        "@gongrzhe/[email protected]",
        "redis://localhost:6379"  //  您的 Redis 服务器连接 URL，请根据实际情况修改
      ]
    }
  }
}

配置参数说明:

'server name': 'redis' (服务器名称，在客户端配置中用于标识和引用该服务器)
'command': 'npx' (运行服务器的命令，这里使用 npx 直接运行 npm 包，无需全局安装)
'args': '["@gongrzhe/[email protected]", "redis://localhost:6379"]' (传递给命令的参数列表)
- '"@gongrzhe/[email protected]"': 指定要运行的 npm 包及其版本。
- '"redis://localhost:6379"': Redis 服务器的连接 URL，请务必根据您的 Redis 服务器地址和端口进行修改。

基本使用方法

启动 Redis 服务器: 确保您的 Redis 服务器已经启动并运行，并且可以通过配置的 URL 访问。
启动 Redis MCP Server: 根据安装步骤，使用 'npx' 或全局安装的方式启动 Redis MCP Server，并提供正确的 Redis 连接 URL。
配置 MCP 客户端: 在您的 MCP 客户端（如 Claude Desktop）中，按照服务器配置示例添加 Redis MCP Server 的配置信息。
在 LLM 中使用工具: 连接成功后，您可以在 LLM 应用中指示 LLM 使用 'redis.set', 'redis.get', 'redis.delete', 'redis.list' 等工具来操作 Redis 数据库。例如，您可以让 LLM 存储一些信息到 Redis 中，并在后续对话中检索出来。

关键词