Skip to content

Commit 156d717

Browse files
authored
Merge pull request #1 from redis/smithery/config-fary
Deployment: Dockerfile and Smithery config
2 parents d5e5dfe + b11a886 commit 156d717

File tree

3 files changed

+108
-0
lines changed

3 files changed

+108
-0
lines changed

Dockerfile

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
2+
FROM python:3.13-slim
3+
4+
# Set working directory
5+
WORKDIR /app
6+
7+
# Copy local code to the container image.
8+
COPY . /app
9+
10+
# Install pip dependencies
11+
RUN pip install --upgrade pip \
12+
&& pip install .
13+
14+
# Expose necessary port if any (MCP typically uses stdio, but if needed, uncomment below)
15+
# EXPOSE 8000
16+
17+
# Run the MCP Server
18+
CMD ["python", "src/main.py"]

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Redis MCP Server
2+
[![smithery badge](https://smithery.ai/server/installations/@redis/mcp-redis)](https://smithery.ai/context/protocol/@redis/mcp-redis)
23

34
## Overview
45
The Redis MCP Server is a **natural language interface** designed for agentic applications to efficiently manage and search data in Redis. It integrates seamlessly with **MCP (Model Content Protocol) clients**, enabling AI-driven workflows to interact with structured and unstructured data in Redis. Using this MCP Server, you can ask questions like:
@@ -35,6 +36,16 @@ Additional tools.
3536

3637

3738
## Installation
39+
40+
### Installing via Smithery
41+
42+
To install Redis MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@redis/mcp-redis):
43+
44+
```bash
45+
npx -y @smithery/cli install @redis/mcp-redis --client claude
46+
```
47+
48+
### Manual Installation
3849
```sh
3950
# Clone the repository
4051
git clone https://github.com/redis/mcp-redis.git

smithery.yaml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
2+
3+
startCommand:
4+
type: stdio
5+
configSchema:
6+
# JSON Schema defining the configuration options for the MCP.
7+
type: object
8+
required: []
9+
properties:
10+
redisHost:
11+
type: string
12+
default: 127.0.0.1
13+
description: Redis IP or hostname
14+
redisPort:
15+
type: number
16+
default: 6379
17+
description: Redis port
18+
redisUsername:
19+
type: string
20+
default: default
21+
description: Redis username
22+
redisPwd:
23+
type: string
24+
default: ""
25+
description: Redis password
26+
redisSSL:
27+
type: boolean
28+
default: false
29+
description: Enable SSL for Redis connection
30+
redisCAPath:
31+
type: string
32+
default: ""
33+
description: CA certificate path for verifying server
34+
redisSSLKeyfile:
35+
type: string
36+
default: ""
37+
description: Client private key file for authentication
38+
redisSSLCertfile:
39+
type: string
40+
default: ""
41+
description: Client certificate file for authentication
42+
redisCertReqs:
43+
type: string
44+
default: required
45+
description: Certificate requirements
46+
redisCACerts:
47+
type: string
48+
default: ""
49+
description: Path to trusted CA certificates file
50+
commandFunction:
51+
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
52+
|-
53+
(config) => ({
54+
command: 'python',
55+
args: ['src/main.py'],
56+
env: {
57+
REDIS_HOST: config.redisHost,
58+
REDIS_PORT: String(config.redisPort),
59+
REDIS_USERNAME: config.redisUsername,
60+
REDIS_PWD: config.redisPwd,
61+
REDIS_SSL: String(config.redisSSL),
62+
REDIS_CA_PATH: config.redisCAPath,
63+
REDIS_SSL_KEYFILE: config.redisSSLKeyfile,
64+
REDIS_SSL_CERTFILE: config.redisSSLCertfile,
65+
REDIS_CERT_REQS: config.redisCertReqs,
66+
REDIS_CA_CERTS: config.redisCACerts
67+
}
68+
})
69+
exampleConfig:
70+
redisHost: 127.0.0.1
71+
redisPort: 6379
72+
redisUsername: default
73+
redisPwd: ""
74+
redisSSL: false
75+
redisCAPath: ""
76+
redisSSLKeyfile: ""
77+
redisSSLCertfile: ""
78+
redisCertReqs: required
79+
redisCACerts: ""

0 commit comments

Comments
 (0)