Skip to content

Commit 357eb05

Browse files
mortensimortensi
committed
README corrected and reorganized
1 parent 7445869 commit 357eb05

File tree

1 file changed

+86
-62
lines changed

1 file changed

+86
-62
lines changed

‎README.md

Lines changed: 86 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,29 @@ The Redis MCP Server is a **natural language interface** designed for agentic ap
1212
- "Store the session with an expiration time"
1313
- "Index and search this vector"
1414

15+
## Table of Contents
16+
- [Overview](#overview)
17+
- [Features](#features)
18+
- [Tools](#tools)
19+
- [Installation](#installation)
20+
- [Quick Start with uvx (Recommended)](#quick-start-with-uvx-recommended)
21+
- [Development Installation](#development-installation)
22+
- [Configuration](#configuration)
23+
- [Configuration via Command Line (Recommended)](#configuration-via-command-line-recommended)
24+
- [Configuration via Environment Variables](#configuration-via-environment-variables)
25+
- [Integration with OpenAI Agents SDK](#integration-with-openai-agents-sdk)
26+
- [Integration with MCP Clients](#integration-with-mcp-clients)
27+
- [Using uvx (Recommended)](#using-uvx-recommended)
28+
- [With Docker](#with-docker)
29+
- [Claude Desktop](#claude-desktop)
30+
- [VS Code with GitHub Copilot](#vs-code-with-github-copilot)
31+
- [Augment](#augment)
32+
- [Contributing](#contributing)
33+
- [License](#license)
34+
- [Badges](#badges)
35+
- [Contact](#contact)
36+
37+
1538
## Features
1639
- **Natural Language Queries**: Enables AI agents to query and update Redis using natural language.
1740
- **Seamless MCP Integration**: Works with any **MCP client** for smooth communication.
@@ -41,20 +64,20 @@ Additional tools.
4164

4265
### Quick Start with uvx (Recommended)
4366

44-
The easiest way to use the Redis MCP Server is with `uvx`, which allows you to run it directly from GitHub without installation:
67+
The easiest way to use the Redis MCP Server is with `uvx`, which allows you to run it directly from GitHub without installation on the MCP Client side:
4568

4669
```sh
4770
# Run with Redis URI
48-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server --url redis://localhost:6379/0
71+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --url redis://localhost:6379/0
4972

50-
# Run with individual parameters
51-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server --host localhost --port 6379 --password mypassword
73+
# Run with Redis URI and SSL
74+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --url "rediss://<USERNAME>:<PASSWORD>@<HOST>:<PORT>?ssl_cert_reqs=required&ssl_ca_certs=<PATH_TO_CERT>"
5275

53-
# Run with SSL
54-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server --url rediss://user:[email protected]:6380/0
76+
# Run with individual parameters
77+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --host localhost --port 6379 --password mypassword
5578

5679
# See all options
57-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server --help
80+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
5881
```
5982

6083
### Development Installation
@@ -88,22 +111,21 @@ When using the CLI interface, you can configure the server with command line arg
88111

89112
```sh
90113
# Basic Redis connection
91-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server \
114+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
92115
--host localhost \
93116
--port 6379 \
94117
--password mypassword
95118

96119
# Using Redis URI (simpler)
97-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server \
120+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
98121
--url redis://user:pass@localhost:6379/0
99122

100123
# SSL connection
101-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server \
102-
--url rediss://user:[email protected]:6380/0 \
103-
--ssl-ca-path /path/to/ca.pem
124+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
125+
--url rediss://user:[email protected]:6379/0
104126

105127
# See all available options
106-
uvx --from git+https://github.com/redis/mcp-redis.git@feature/uvx-cli-support redis-mcp-server --help
128+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
107129
```
108130

109131
**Available CLI Options:**
@@ -198,82 +220,86 @@ The simplest way to configure MCP clients is using `uvx`. Here are examples for
198220

199221
#### Claude Desktop
200222

201-
Add this to your `claude_desktop_config.json`:
223+
Add this to your `claude_desktop_config.json`, remember to provide the full path to `uvx`.
202224

203225
```json
204226
{
205-
"mcpServers": {
206-
"redis": {
207-
"command": "uvx",
208-
"args": [
209-
"redis-mcp-server",
210-
"--url", "redis://localhost:6379/0"
211-
]
227+
"mcpServers": {
228+
"redis-mcp-server": {
229+
"type": "stdio",
230+
"command": "/Users/mortensi/.local/bin/uvx",
231+
"args": [
232+
"--from", "git+https://github.com/redis/mcp-redis.git",
233+
"redis-mcp-server",
234+
"--url", "redis://localhost:6379/0"
235+
]
236+
}
212237
}
213-
}
214238
}
215239
```
216240

217-
Or with individual parameters:
241+
If you'd like to test the [Redis MCP Server](https://smithery.ai/server/@redis/mcp-redis) via Smithery, you can configure Claude Desktop automatically:
242+
243+
```bash
244+
npx -y @smithery/cli install @redis/mcp-redis --client claude
245+
```
246+
247+
Follow the prompt and provide the details to configure the server and connect to Redis (e.g. using a Redis Cloud database).
248+
The procedure will create the proper configuration in the `claude_desktop_config.json` configuration file.
249+
250+
#### VS Code with GitHub Copilot
251+
252+
Add this to your `settings.json`:
218253

219254
```json
220-
{
221-
"mcpServers": {
222-
"redis": {
223-
"command": "uvx",
224-
"args": [
225-
"redis-mcp-server",
226-
"--host", "your-redis-host",
227-
"--port", "6379",
228-
"--password", "your-password"
229-
]
255+
"mcp": {
256+
"servers": {
257+
"Redis MCP Server": {
258+
"type": "stdio",
259+
"command": "uvx",
260+
"args": [
261+
"--from", "git+https://github.com/redis/mcp-redis.git",
262+
"redis-mcp-server",
263+
"--url", "redis://localhost:6379/0"
264+
]
265+
},
230266
}
231-
}
232-
}
267+
},
233268
```
234269

235-
#### VS Code with GitHub Copilot
270+
#### Augment
236271

237-
Add this to your `.vscode/mcp.json`:
272+
Import the server via JSON:
238273

239274
```json
240275
{
241-
"servers": {
242-
"redis": {
243-
"type": "stdio",
276+
"mcpServers": {
277+
"Redis MCP Server": {
244278
"command": "uvx",
245279
"args": [
280+
"--from",
281+
"git+https://github.com/redis/mcp-redis.git",
246282
"redis-mcp-server",
247-
"--url", "redis://localhost:6379/0"
283+
"--url",
284+
"redis://localhost:6379/0"
248285
]
249286
}
250287
}
251288
}
252289
```
253290

254-
## Integration with Claude Desktop
255-
256-
### Via Smithery
257-
258-
If you'd like to test the [Redis MCP Server](https://smithery.ai/server/@redis/mcp-redis) deployed [by Smithery](https://smithery.ai/docs/deployments), you can configure Claude Desktop automatically:
259-
260-
```bash
261-
npx -y @smithery/cli install @redis/mcp-redis --client claude
262-
```
263-
264-
Follow the prompt and provide the details to configure the server and connect to Redis (e.g. using a Redis Cloud database).
265-
The procedure will create the proper configuration in the `claude_desktop_config.json` configuration file.
266291

267292
### Manual configuration
268293

269-
You can configure Claude Desktop to use this MCP Server.
294+
You can configure Claude Desktop or any other MCP Client to use this MCP Server running the main file directly (it uses environment variables).
295+
The following example is for Claude Desktop, but the same applies to any other MCP Client.
270296

271297
1. Specify your Redis credentials and TLS configuration
272298
2. Retrieve your `uv` command full path (e.g. `which uv`)
273299
3. Edit the `claude_desktop_config.json` configuration file
274300
- on a MacOS, at `~/Library/Application\ Support/Claude/`
275301

276-
```commandline
302+
```json
277303
{
278304
"mcpServers": {
279305
"redis": {
@@ -297,7 +323,7 @@ You can configure Claude Desktop to use this MCP Server.
297323
}
298324
```
299325

300-
### Using with Docker
326+
### With Docker
301327

302328
You can use a dockerized deployment of this server. You can either build your own image or use the official [Redis MCP Docker](https://hub.docker.com/r/mcp/redis) image.
303329

@@ -309,7 +335,7 @@ docker build -t mcp-redis .
309335

310336
Finally, configure Claude Desktop to create the container at start-up. Edit the `claude_desktop_config.json` and add:
311337

312-
```commandline
338+
```json
313339
{
314340
"mcpServers": {
315341
"redis": {
@@ -345,16 +371,15 @@ To use the Redis MCP Server with VS Code, you need:
345371

346372
1. Enable the [agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode) tools. Add the following to your `settings.json`:
347373

348-
```commandline
374+
```json
349375
{
350376
"chat.agent.enabled": true
351377
}
352378
```
353379

354380
2. Add the Redis MCP Server configuration to your `mcp.json` or `settings.json`:
355381

356-
```commandline
357-
// Example .vscode/mcp.json
382+
```json
358383
{
359384
"servers": {
360385
"redis": {
@@ -377,8 +402,7 @@ To use the Redis MCP Server with VS Code, you need:
377402
}
378403
```
379404

380-
```commandline
381-
// Example settings.json
405+
```json
382406
{
383407
"mcp": {
384408
"servers": {

0 commit comments

Comments
 (0)