{"_id":"@chenyingxian/redis-mcp","_rev":"2-32c71b1fa761d2a4d2a5f00996ad8b11","name":"@chenyingxian/redis-mcp","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@chenyingxian/redis-mcp","version":"0.1.0","keywords":["mcp","model-context-protocol","redis","sentinel","cluster","ioredis"],"author":"","license":"MIT","_id":"@chenyingxian/redis-mcp@0.1.0","maintainers":[{"name":"chenyingxian","email":"a1030307996@gmail.com"}],"bin":{"redis-mcp":"dist/index.js"},"dist":{"shasum":"bb8896f407a99c9f0b0ace0c395bbd4204d78c80","tarball":"https://registry.npmjs.org/@chenyingxian/redis-mcp/-/redis-mcp-0.1.0.tgz","fileCount":22,"integrity":"sha512-HhY+sJHg8Zi0/pdWAZ2yhpxF8FQ6G7RkHA34RFT+xCl5CoMdK2Gq8jLsW8URkcGc9bld+Oa+/gWXH1RTMl6LQA==","signatures":[{"sig":"MEQCH3XoXB6psom4PjeteLcgu0S1+AmNq8RrGDhqCe+23T8CIQC0CEN38bClg3svyPXIFalynAzguzApcjuaoQ/IDrPnCw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":112725},"type":"module","engines":{"node":">=18"},"scripts":{"build":"tsc -p tsconfig.json","start":"node dist/index.js","prepack":"npm run build"},"_npmUser":{"name":"chenyingxian","email":"a1030307996@gmail.com"},"_npmVersion":"11.9.0","description":"A Redis Model Context Protocol server supporting standalone, Sentinel, Cluster, TLS, and Unix socket deployments.","directories":{},"_nodeVersion":"24.14.0","dependencies":{"ioredis":"^5.6.1","@modelcontextprotocol/sdk":"^1.13.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.3","@types/node":"^22.15.29"},"_npmOperationalInternal":{"tmp":"tmp/redis-mcp_0.1.0_1779356802687_0.056699570380591036","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@chenyingxian/redis-mcp","version":"0.1.1","description":"A Redis Model Context Protocol server supporting standalone, Sentinel, Cluster, TLS, and Unix socket deployments.","type":"module","bin":{"redis-mcp":"dist/index.js"},"scripts":{"build":"tsc -p tsconfig.json","start":"node dist/index.js","prepack":"npm run build"},"keywords":["mcp","model-context-protocol","redis","sentinel","cluster","ioredis"],"author":"","license":"MIT","engines":{"node":">=18"},"publishConfig":{"access":"public"},"dependencies":{"@modelcontextprotocol/sdk":"^1.13.0","ioredis":"^5.6.1"},"devDependencies":{"@types/node":"^22.15.29","typescript":"^5.8.3"},"_id":"@chenyingxian/redis-mcp@0.1.1","_nodeVersion":"24.14.0","_npmVersion":"11.9.0","dist":{"integrity":"sha512-CvxKbsgccKdPizpa+/Xx/mo28jozYWW7NKy2FOTGbNxjYmD/oCsWjogsY/tUumFyQ8a/LZ36SBqNg1ayXW0mTg==","shasum":"c6fbfb9a3ad6351aea35dc06ad82671dba2f55af","tarball":"https://registry.npmjs.org/@chenyingxian/redis-mcp/-/redis-mcp-0.1.1.tgz","fileCount":22,"unpackedSize":113172,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDgjqKwtNLMpEcF9Jnr0sR7Xj/xqnj7Vu2XBQy217TsbgIhAJZ1mpCJizv9ueRdhnkr97DOb+XQvQRyVQfHelpoE6Kt"}]},"_npmUser":{"name":"chenyingxian","email":"a1030307996@gmail.com"},"directories":{},"maintainers":[{"name":"chenyingxian","email":"a1030307996@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/redis-mcp_0.1.1_1779357691126_0.5136189971981697"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-21T09:46:42.492Z","modified":"2026-05-21T10:01:31.405Z","0.1.0":"2026-05-21T09:46:42.814Z","0.1.1":"2026-05-21T10:01:31.298Z"},"license":"MIT","keywords":["mcp","model-context-protocol","redis","sentinel","cluster","ioredis"],"description":"A Redis Model Context Protocol server supporting standalone, Sentinel, Cluster, TLS, and Unix socket deployments.","maintainers":[{"name":"chenyingxian","email":"a1030307996@gmail.com"}],"readme":"# redis-mcp\r\n\r\nRedis MCP 服务，支持 standalone、代理入口、Sentinel、Cluster、TLS 和 Unix socket 等 Redis 架构，用于安全读取和受控操作 Redis 数据。\r\n\r\n该包面向需要访问 Redis 的 MCP 客户端。连接信息可以通过环境变量传入，也可以通过 JSON 配置文件传入，配置文件支持多个工作区和多个 Redis 源。源码和 npm 包中不包含真实账号、主机、密码、token 或个人本机路径。\r\n\r\n## 文档\r\n\r\n- [配置说明](./CONFIG.zh-CN.md)\r\n- [MCP 工具](./MCP_TOOLS.zh-CN.md)\r\n- [English README](./README.md)\r\n\r\n## 安装\r\n\r\n```bash\r\nnpm install -g @chenyingxian/redis-mcp\r\n```\r\n\r\n也可以不全局安装，直接使用：\r\n\r\n```bash\r\nnpx @chenyingxian/redis-mcp\r\n```\r\n\r\n## 快速配置\r\n\r\nStandalone Redis 或 Redis 代理入口：\r\n\r\n```bash\r\nREDIS_MCP_MODE=standalone\r\nREDIS_URL=redis://localhost:6379/0\r\nREDIS_MCP_READ_ONLY=true\r\nREDIS_MCP_MAX_SCAN_COUNT=100\r\nREDIS_MCP_MAX_RESULT_BYTES=1048576\r\n```\r\n\r\nMCP 客户端配置示例：\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"redis\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"@chenyingxian/redis-mcp@latest\"],\r\n      \"env\": {\r\n        \"REDIS_MCP_MODE\": \"standalone\",\r\n        \"REDIS_URL\": \"redis://localhost:6379/0\",\r\n        \"REDIS_MCP_READ_ONLY\": \"true\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n配置文件维护工具默认只读。只有在需要 MCP 客户端新增、更新、删除或切换 Redis 源时，才设置 `REDIS_MCP_ALLOW_CONFIG_MUTATION=true`。\r\n\r\nSentinel、Cluster、TLS、Unix socket 和安全控制配置见 [CONFIG.zh-CN.md](./CONFIG.zh-CN.md)。\r\n\r\n多个 Redis 源可以通过 `REDIS_MCP_CONFIG_FILE` 指向 JSON 配置文件：\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"redis\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"@chenyingxian/redis-mcp@latest\"],\r\n      \"env\": {\r\n        \"REDIS_MCP_CONFIG_FILE\": \"/path/to/redis-mcp.config.json\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n## 工具\r\n\r\n- `redis_ping`：检查 Redis 连接。\r\n- `redis_list_sources`：列出已配置的 Redis 工作区和源。\r\n- `redis_config_read`：读取脱敏后的配置文件内容。\r\n- `redis_config_upsert_source`：新增或更新一个 Redis 源配置。\r\n- `redis_config_remove_source`：删除一个 Redis 源配置。\r\n- `redis_config_set_default`：设置某个工作区的默认源。\r\n- `redis_get`：读取字符串值。\r\n- `redis_set`：写入字符串值，可设置过期时间。\r\n- `redis_delete`：删除一个或多个 key。\r\n- `redis_exists`：检查 key 是否存在。\r\n- `redis_expire`：设置 key 过期时间。\r\n- `redis_ttl`：读取 key TTL。\r\n- `redis_type`：读取 key 类型。\r\n- `redis_scan`：按 pattern 扫描 key。\r\n- `redis_hgetall`：读取 hash 全部字段。\r\n- `redis_hset`：写入 hash 字段。\r\n- `redis_lrange`：读取 list 范围。\r\n- `redis_smembers`：读取 set 成员。\r\n- `redis_zrange`：读取 sorted set 范围。\r\n- `redis_info`：读取 Redis INFO，支持原始文本或解析后的 JSON。\r\n- `redis_command`：执行允许的 Redis 命令。\r\n\r\n参数和行为说明见 [MCP_TOOLS.zh-CN.md](./MCP_TOOLS.zh-CN.md)。\r\n\r\n## 安全说明\r\n\r\n- 只需要查询时，建议设置 `REDIS_MCP_READ_ONLY=true`。\r\n- Redis 支持 ACL 时，建议使用最小权限账号。\r\n- 不要发布真实 `.env` 文件、内部主机、用户名、密码、token 或私有连接串。\r\n- `FLUSHALL`、`FLUSHDB`、`CONFIG`、`SHUTDOWN`、`MODULE`、`DEBUG` 等危险管理命令默认禁止。\r\n- 可以使用 `REDIS_MCP_KEY_PREFIX` 限制 key 操作范围。\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n","readmeFilename":"README.zh-CN.md"}