Skip to content

Commit d892956

Browse files
committed
Information to use the PyPI package
1 parent a29ec16 commit d892956

File tree

1 file changed

+59
-22
lines changed

1 file changed

+59
-22
lines changed

README.md

Lines changed: 59 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ The Redis MCP Server is a **natural language interface** designed for agentic ap
2828
- [Features](#features)
2929
- [Tools](#tools)
3030
- [Installation](#installation)
31-
- [Quick Start with uvx](#quick-start-with-uvx)
31+
- [From PyPI (recommended)](#from-pypi-recommended)
32+
- [Testing the PyPI package](#testing-the-pypi-package)
33+
- [From GitHub](#from-github)
3234
- [Development Installation](#development-installation)
3335
- [With Docker](#with-docker)
3436
- [Configuration](#configuration)
@@ -76,23 +78,56 @@ Additional tools.
7678

7779
## Installation
7880

79-
The Redis MCP Server is available as a Python package, and can be installed from PyPI.
81+
The Redis MCP Server is available as a PyPI package and as direct installation from the GitHub repository.
82+
83+
### From PyPI (recommended)
84+
Configuring the latest Redis MCP Server version from PyPI, as an example, can be done importing the following JSON configuration in the desired framework or tool.
85+
The `uvx` command will download the server on the fly (if not cached already), create a temporary environment, and then run it.
86+
87+
```commandline
88+
{
89+
"mcpServers": {
90+
"RedisMCPServer": {
91+
"command": "uvx",
92+
"args": [
93+
"--from",
94+
"redis-mcp-server@latest",
95+
"redis-mcp-server",
96+
"--url",
97+
"\"redis://localhost:6379/0\""
98+
]
99+
}
100+
}
101+
}
102+
```
103+
104+
You will find examples for different platforms along the README.
105+
106+
### Testing the PyPI package
107+
108+
You can install the package as follows:
80109

81110
```sh
82111
pip install redis-mcp-server
83112
```
84113

85-
Alternatively you can use `uv` to install the package and its dependencies.
114+
And start it using `uv` the package in your environment.
86115

87116
```sh
88117
uv python install 3.13
89118
uv sync
90119
uv run redis-mcp-server --url redis://localhost:6379/0
91120
```
92121

93-
### Running the latest bits
122+
However, starting the MCP Server is most useful when delegate to the framework or tool where this MCP Server is configured.
123+
124+
### From GitHub
125+
126+
You can configure the desired Redis MCP Server version with `uvx`, which allows you to run it directly from GitHub (from a branch, or use a tagged release).
94127

95-
The easiest way to use the Redis MCP Server is with `uvx`, which allows you to run it directly from GitHub (from a branch, or use a tagged release). It is recommended to use a tagged release, the `main` branch is under active development and may contain breaking changes. As an example, you can execute the following command to run the `0.2.0` release:
128+
> It is recommended to use a tagged release, the `main` branch is under active development and may contain breaking changes.
129+
130+
As an example, you can execute the following command to run the `0.2.0` release:
96131

97132
```commandline
98133
uvx --from git+https://github.com/redis/[email protected] redis-mcp-server --url redis://localhost:6379/0
@@ -229,21 +264,21 @@ When using the CLI interface, you can configure the server with command line arg
229264

230265
```sh
231266
# Basic Redis connection
232-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
267+
uvx --from redis-mcp-server@latest redis-mcp-server \
233268
--host localhost \
234269
--port 6379 \
235270
--password mypassword
236271

237272
# Using Redis URI (simpler)
238-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
273+
uvx --from redis-mcp-server@latest redis-mcp-server \
239274
--url redis://user:pass@localhost:6379/0
240275

241276
# SSL connection
242-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
277+
uvx --from redis-mcp-server@latest redis-mcp-server \
243278
--url rediss://user:[email protected]:6379/0
244279

245280
# See all available options
246-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
281+
uvx --from redis-mcp-server@latest redis-mcp-server --help
247282
```
248283

249284
**Available CLI Options:**
@@ -337,7 +372,9 @@ You can troubleshoot your agent workflows using the [OpenAI dashboard](https://p
337372

338373
### Augment
339374

340-
You can configure the Redis MCP Server in Augment by importing the server via JSON:
375+
The preferred way of configuring the Redis MCP Server in Augment is to use the [Easy MCP](https://docs.augmentcode.com/setup-augment/mcp#redis) feature.
376+
377+
You can also configure the Redis MCP Server in Augment manually by importing the server via JSON:
341378

342379
```json
343380
{
@@ -346,7 +383,7 @@ You can configure the Redis MCP Server in Augment by importing the server via JS
346383
"command": "uvx",
347384
"args": [
348385
"--from",
349-
"git+https://github.com/redis/mcp-redis.git",
386+
"redis-mcp-server@latest",
350387
"redis-mcp-server",
351388
"--url",
352389
"redis://localhost:6379/0"
@@ -362,17 +399,17 @@ The simplest way to configure MCP clients is using `uvx`. Add the following JSON
362399

363400
```json
364401
{
365-
"mcpServers": {
366-
"redis-mcp-server": {
367-
"type": "stdio",
368-
"command": "/Users/mortensi/.local/bin/uvx",
369-
"args": [
370-
"--from", "git+https://github.com/redis/mcp-redis.git",
371-
"redis-mcp-server",
372-
"--url", "redis://localhost:6379/0"
373-
]
374-
}
402+
"mcpServers": {
403+
"redis-mcp-server": {
404+
"type": "stdio",
405+
"command": "/Users/mortensi/.local/bin/uvx",
406+
"args": [
407+
"--from", "redis-mcp-server@latest",
408+
"redis-mcp-server",
409+
"--url", "redis://localhost:6379/0"
410+
]
375411
}
412+
}
376413
}
377414
```
378415

@@ -404,7 +441,7 @@ You can start the GitHub desired version of the Redis MCP server using `uvx` by
404441
"type": "stdio",
405442
"command": "uvx",
406443
"args": [
407-
"--from", "git+https://github.com/redis/mcp-redis.git",
444+
"--from", "redis-mcp-server@latest",
408445
"redis-mcp-server",
409446
"--url", "redis://localhost:6379/0"
410447
]

0 commit comments

Comments
 (0)