Skip to content

Commit 4e660a2

Browse files
committed
Update Readme
1 parent 52e60e6 commit 4e660a2

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

src/redis/README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
A Model Context Protocol server that provides access to Redis databases. This server enables LLMs to interact with Redis key-value stores through a set of standardized tools.
44

5+
## Prerequisites
6+
7+
1. Redis server must be installed and running
8+
- [Download Redis](https://redis.io/download)
9+
- For Windows users: Use [Windows Subsystem for Linux (WSL)](https://redis.io/docs/getting-started/installation/install-redis-on-windows/) or [Memurai](https://www.memurai.com/) (Redis-compatible Windows server)
10+
- Default port: 6379
11+
12+
## Common Issues & Solutions
13+
14+
### Connection Errors
15+
16+
**ECONNREFUSED**
17+
- **Cause**: Redis server is not running or unreachable
18+
- **Solution**:
19+
- Verify Redis is running: `redis-cli ping` should return "PONG"
20+
- Check Redis service status: `systemctl status redis` (Linux) or `brew services list` (macOS)
21+
- Ensure correct port (default 6379) is not blocked by firewall
22+
- Verify Redis URL format: `redis://hostname:port`
23+
24+
### Server Behavior
25+
26+
- The server implements exponential backoff with a maximum of 5 retries
27+
- Initial retry delay: 1 second, maximum delay: 30 seconds
28+
- Server will exit after max retries to prevent infinite reconnection loops
29+
530
## Components
631

732
### Tools
@@ -77,4 +102,4 @@ docker build -t mcp/redis -f src/redis/Dockerfile .
77102

78103
## License
79104

80-
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
105+
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

0 commit comments

Comments
 (0)