使用说明

项目简介

DiceDB MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端,它充当LLM客户端和DiceDB数据库服务器之间的桥梁。通过提供一系列预定义的工具,该服务器允许LLM应用以标准化的方式访问和操作DiceDB数据库中的数据。

主要功能点

  • 连接性检查: 'ping' 工具可以检测与DiceDB服务器的连接是否正常。
  • 消息回显: 'echo' 工具允许通过DiceDB服务器回显指定消息,用于测试或调试。
  • 数据读取: 'get' 工具根据键从DiceDB数据库中检索值。
  • 数据写入: 'set' 工具允许在DiceDB数据库中设置键值对,并支持多种可选参数如过期时间、存在性条件等。
  • 数据删除: 'del' 工具可以删除DiceDB数据库中一个或多个指定的键。
  • 数值递增: 'incr' 工具将DiceDB数据库中键对应的整数值递增1。

安装步骤

  1. 环境准备: 确保已安装 Go 1.24 或更高版本。
  2. 安装 DiceDB MCP 服务器: 打开终端并执行以下命令安装 'dicedb-mcp':
    go install github.com/pottekkat/dicedb-mcp@latest
  3. 查找可执行文件路径: 安装完成后,使用以下命令找到 'dicedb-mcp' 可执行文件的路径:
    which dicedb-mcp
    请记录下输出的路径,后续配置需要使用。

服务器配置

MCP客户端(如 Claude Desktop, Cursor 等)需要配置才能连接到 DiceDB MCP 服务器。配置信息通常以 JSON 格式提供。以下是配置示例,您需要根据实际情况修改 'command' 字段中的路径:

{
    "mcpServers": {
        "dicedb-mcp": {
            "command": "/path/to/dicedb-mcp"  // 将 "/path/to/dicedb-mcp" 替换为 'which dicedb-mcp' 命令输出的路径
        }
    }
}
  • '"mcpServers"': 定义 MCP 服务器配置的顶级键。
  • '"dicedb-mcp"': 为该 DiceDB MCP 服务器定义的名称,可以自定义,在客户端中引用此名称。
  • '"command"': 必须配置。指定 DiceDB MCP 服务器可执行文件的路径。请将 '/path/to/dicedb-mcp' 替换为您在安装步骤中找到的实际路径。

将以上 JSON 配置添加到您的 MCP 客户端配置文件中,例如 'claude_desktop_config.json' (Claude Desktop) 或 'mcp.json' (Cursor)。

基本使用方法

配置完成后,在支持 MCP 协议的 LLM 客户端中,您可以通过调用预定义的工具来与DiceDB数据库进行交互。例如,您可以指示 LLM 客户端使用 'ping' 工具检查连接,或使用 'get' 工具根据键检索数据。具体的工具调用方式和参数需要参考您的 LLM 客户端的使用文档。

例如,在支持自然语言工具调用的LLM应用中,您可以指示模型执行以下操作:

  • "请使用 'ping' 工具检查 DiceDB 服务器是否可用"
  • "请使用 'get' 工具,键为 'mykey',从 DiceDB 获取数据"
  • "请使用 'set' 工具,键为 'newkey',值为 'myvalue',在 DiceDB 中设置数据"

LLM 客户端会将这些自然语言指令转换为对 DiceDB MCP 服务器特定工具的调用,并返回 DiceDB 的响应结果。

信息

分类

数据库与文件