From 69b730360c80eadd289f53550662a16cb1002966 Mon Sep 17 00:00:00 2001 From: mortensi Date: Thu, 16 Oct 2025 09:26:59 +0200 Subject: [PATCH 1/2] connecting with --url, specifications and instructions --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 34cb7f8..972735f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ [![PyPI - Version](https://img.shields.io/pypi/v/redis-mcp-server)](https://pypi.org/project/redis-mcp-server/) [![Python Version](https://img.shields.io/badge/python-3.13%2B-blue&logo=redis)](https://www.python.org/downloads/) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt) -[![smithery badge](https://smithery.ai/badge/@redis/mcp-redis)](https://smithery.ai/server/@redis/mcp-redis) [![Verified on MseeP](https://mseep.ai/badge.svg)](https://mseep.ai/app/70102150-efe0-4705-9f7d-87980109a279) [![Docker Image Version](https://img.shields.io/docker/v/mcp/redis?sort=semver&logo=docker&label=Docker)](https://hub.docker.com/r/mcp/redis) [![codecov](https://codecov.io/gh/redis/mcp-redis/branch/master/graph/badge.svg?token=yenl5fzxxr)](https://codecov.io/gh/redis/mcp-redis) @@ -102,7 +101,41 @@ The `uvx` command will download the server on the fly (if not cached already), c } ``` -You will find examples for different platforms along the README. +#### URL specification + +The format to specify the `--url` argument follows the [redis](https://www.iana.org/assignments/uri-schemes/prov/redis) and [rediss](https://www.iana.org/assignments/uri-schemes/prov/rediss) schemes: + +```commandline +redis://user:secret@localhost:6379/0?foo=bar&qux=baz +``` + +As an example, you can easily connect to a localhost server with: + +```commandline +redis://localhost:6379/0 +``` + +Where `0` is the [logical database](https://redis.io/docs/latest/commands/select/) you'd like to connect to. + +For an encrypted connection to the database (e.g., connecting to a [Redis Cloud](https://redis.io/cloud/) database), you'd use the `rediss` scheme. + +```commandline +rediss://user:secret@localhost:6379/0?foo=bar&qux=baz +``` + +To verify the server's identity, specify `ssl_ca_certs`. + +```commandline +rediss://user:secret@hostname:port?ssl_cert_reqs=required&ssl_ca_certs=path_to_the_certificate +``` + +For an unverified connection, set `ssl_cert_reqs` to `none` + +```commandline +rediss://user:secret@hostname:port?ssl_cert_reqs=none +``` + +Configure your connection using the available options in the section "Available CLI Options". ### Testing the PyPI package From e6e97111a91ec7c04bc41693148aac745ff791cf Mon Sep 17 00:00:00 2001 From: Vasil Chomakov Date: Fri, 17 Oct 2025 16:30:58 +0300 Subject: [PATCH 2/2] Remove Smithery integration --- README.md | 8 ------ smithery.yaml | 79 --------------------------------------------------- 2 files changed, 87 deletions(-) delete mode 100644 smithery.yaml diff --git a/README.md b/README.md index 972735f..d9f913b 100644 --- a/README.md +++ b/README.md @@ -487,14 +487,6 @@ The simplest way to configure MCP clients is using `uvx`. Add the following JSON } ``` -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: - -```bash -npx -y @smithery/cli install @redis/mcp-redis --client claude -``` - -Follow the prompt and provide the details to configure the server and connect to Redis (e.g. using a Redis Cloud database). -The procedure will create the proper configuration in the `claude_desktop_config.json` configuration file. ### VS Code with GitHub Copilot diff --git a/smithery.yaml b/smithery.yaml deleted file mode 100644 index 48c5bdf..0000000 --- a/smithery.yaml +++ /dev/null @@ -1,79 +0,0 @@ -# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml - -startCommand: - type: stdio - configSchema: - # JSON Schema defining the configuration options for the MCP. - type: object - required: [] - properties: - redisHost: - type: string - default: 127.0.0.1 - description: Redis IP or hostname - redisPort: - type: number - default: 6379 - description: Redis port - redisUsername: - type: string - default: default - description: Redis username - redisPwd: - type: string - default: "" - description: Redis password - redisSSL: - type: boolean - default: false - description: Enable SSL for Redis connection - redisCAPath: - type: string - default: "" - description: CA certificate path for verifying server - redisSSLKeyfile: - type: string - default: "" - description: Client private key file for authentication - redisSSLCertfile: - type: string - default: "" - description: Client certificate file for authentication - redisCertReqs: - type: string - default: required - description: Certificate requirements - redisCACerts: - type: string - default: "" - description: Path to trusted CA certificates file - commandFunction: - # A JS function that produces the CLI command based on the given config to start the MCP on stdio. - |- - (config) => ({ - command: 'uv', - args: ['run', 'python', 'src/main.py'], - env: { - REDIS_HOST: config.redisHost, - REDIS_PORT: String(config.redisPort), - REDIS_USERNAME: config.redisUsername, - REDIS_PWD: config.redisPwd, - REDIS_SSL: String(config.redisSSL), - REDIS_CA_PATH: config.redisCAPath, - REDIS_SSL_KEYFILE: config.redisSSLKeyfile, - REDIS_SSL_CERTFILE: config.redisSSLCertfile, - REDIS_CERT_REQS: config.redisCertReqs, - REDIS_CA_CERTS: config.redisCACerts - } - }) - exampleConfig: - redisHost: 127.0.0.1 - redisPort: 6379 - redisUsername: default - redisPwd: "" - redisSSL: false - redisCAPath: "" - redisSSLKeyfile: "" - redisSSLCertfile: "" - redisCertReqs: required - redisCACerts: ""