Valkey模型上下文协议服务器

为Valkey数据库提供AI代理安全结构化访问的MCP服务器,支持查询数据、检查键值和调试实例。

  • by ItsJooL
  • Go
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 ItsJooL/valkey-mcp

使用说明

Valkey MCP服务器

Valkey的MCP(模型上下文协议)服务器,为Claude等AI代理提供对Valkey数据库的安全、结构化访问。直接从AI助手查询数据、检查密钥和调试Valkey实例。

特性

  • 70+工具 -全面覆盖Valkey操作(字符串、列表、哈希、集合、排序集合、流、服务器管理、集群管理)
  • 类型安全操作 -输入验证和结构化响应
  • 完整的错误处理 -带有上下文的详细错误消息
  • 单个二进制 -无运行时依赖关系(编译的Go二进制文件)
  • Docker支持 -多阶段构建,实现最小的容器映像
  • Kubernetes就绪 -使用清单和ConfigMaps进行部署
  • MCP兼容 -适用于Claude Desktop、其他MCP客户端和自定义应用程序

快速开始

先决条件

  • 瓦尔基 服务器正在运行(本地或远程)
  • 转到1.22+ (用于从源代码构建)或二进制安装

安装

选项1:使用Go安装(推荐)

go install github.com/ItsJooL/valkey-mcp-server/cmd/valkey-mcp-server@latest
# Binary installed to: $GOPATH/bin/valkey-mcp-server

选项2:从源代码构建

git clone https://github.com/ItsJooL/valkey-mcp-server
cd valkey-mcp-server
make build
# Binary: ./valkey-mcp-server

选项3:下载二进制文件

# Visit: https://github.com/ItsJooL/valkey-mcp-server/releases
# Download the binary for your OS
chmod +x valkey-mcp-server

本地运行

基本用法(连接到本地主机:6379)

valkey-mcp-server

使用自定义连接

valkey-mcp-server --url valkey://myhost:6379 --password mysecret --db 1

有环境变量

export VALKEY_URL=valkey://myhost:6379
export VALKEY_PASSWORD=mysecret
export VALKEY_DB=1
valkey-mcp-server

配置

命令行标志

-url string        Valkey connection URL (default: "valkey://localhost:6379")
-password string    Valkey authentication password
-db int            Database number 0-15 (default: 0)

环境变量

  • VALKEY_URL -连接URL(例如。, valkey://localhost:6379 或 redis://localhost:6379)
  • VALKEY_PASSWORD -身份验证密码
  • VALKEY_DB -数据库编号(0-15)

URL格式示例

valkey://localhost:6379           # Local Valkey
redis://localhost:6379            # Redis protocol (compatible)
valkey://user:password@host:6379  # With password in URL
rediss://localhost:6380           # TLS connection

与AI集成

将以下内容添加到您的 mcp.json:

{
  "mcpServers": {
    "valkey": {
      "command": "/path/to/valkey-mcp-server",
      "args": ["-url", "valkey://valkey-address:6379", "-db", "0"],
      "env": {
        "VALKEY_PASSWORD": "valkey-password-here"
      }
    }
  }
}

码头工人

构建并运行

docker build -t valkey-mcp-server .
docker run --rm -e VALKEY_URL=valkey://host.docker.internal:6379 valkey-mcp-server

或使用Mise

mise docker-build
mise docker-run

库贝内特斯

部署到集群

kubectl apply -f k8s/valkey-mcp-server.yaml

自定义连接(编辑ConfigMap)

kubectl edit configmap valkey-mcp-config
kubectl rollout restart deployment/valkey-mcp-server

看 k8s/README.md 了解详细的Kubernetes设置。

发展

此项目使用 系争点 用于任务管理和依赖关系管理。

运行任务:

mise test              # Run all tests
mise test-coverage     # With coverage report
mise lint              # Check code quality
mise build             # Build binary
mise fmt               # Format code

查看所有可用任务:

mise task ls

可用工具

该服务器提供72个工具,涵盖以下类别:

类别 工具 示例
服务器 5 server_ping, server_info, dbsize, config_get, slowlog_get
钥匙 12 scan_keys, get_key_type, delete_keys, expire_key, rename_key, memory_usage
字符串 9 get_string, set_string, append_string, incr_string, mget_strings
列表 10 lpush_list, rpush_list, lrange_list, lpop_list, lset_list, ltrim_list
哈希值 11 set_hash, get_hash, hget_hash_field, hdel_hash, hincrby_hash
集合 7 add_set, remove_set_member, get_set_members, sinter_sets, sunion_sets
流 4 xadd_stream, xrange_stream, xread_stream, xlen_stream
其他 14 脚本、集群命令、位操作等。

跑 valkey-mcp-server --help 或者在连接时查询工具列表以查看所有可用工具。

许可证

看 许可证 文件。