@@ -19,15 +19,15 @@ The sections below describe the ways you can do this.
19
19
20
20
## Smithery
21
21
22
- Smithery provides a searchable repository of scripts that add configurations
23
- for many MCP services to client apps.
22
+ [ Smithery] ( https://smithery.ai/ ) provides a searchable repository of scripts
23
+ that add configurations for many MCP services to client apps.
24
24
The easiest way to configure your client is to use the
25
25
[ Smithery tool for Redis MCP] ( https://smithery.ai/server/@redis/mcp-redis ) .
26
26
27
27
When you select your client from the ** Install** bar on the Redis MCP page,
28
28
you will see a command line that you can copy and paste into a terminal.
29
29
Running this command will configure your client app to use Redis MCP. (Note
30
- that you need to have [ Node.js] ( https://nodejs.org/en ) installed to run
30
+ that you must have [ Node.js] ( https://nodejs.org/en ) installed to run
31
31
the Smithery scripts.) For example, the command line for
32
32
[ Claude Desktop] ( https://claude.ai/download ) is
33
33
@@ -42,14 +42,21 @@ your Redis database.
42
42
43
43
You can also add the configuration for Redis MCP to your client app
44
44
manually. The exact method varies from client to client but the
45
- basic approach is similar in each case.
45
+ basic approach is similar in each case. The pages listed below
46
+ give the general configuration details for some common MCP client tools:
47
+
48
+ - [ Claude Desktop] ( https://modelcontextprotocol.io/quickstart/user )
49
+ - [ Github Copilot for VSCode] ( https://code.visualstudio.com/docs/copilot/chat/mcp-servers )
50
+ - [ OpenAI] ( https://openai.github.io/openai-agents-python/mcp/ )
51
+
52
+ ### Local servers
46
53
47
54
For a locally-running MCP server, you need to edit the configuration
48
55
file to add the command that launches the server, along with its
49
56
arguments. For example, with Claude Desktop, you can locate the
50
57
file by selecting ** Settings** from the menu, then selecting the
51
58
** Developer** tab, and then clicking the ** Edit Config** button.
52
- When you open this JSON file, you should add your settings as
59
+ Open this JSON file and add your settings as
53
60
shown below:
54
61
55
62
``` json
@@ -58,7 +65,7 @@ shown below:
58
65
.
59
66
.
60
67
"redis" : {
61
- "command" : " <path-to-uv-command>> " ,
68
+ "command" : " <path-to-uv-command>" ,
62
69
"args" : [
63
70
" --directory" ,
64
71
" <your-folder-path>/mcp-redis" ,
@@ -96,4 +103,55 @@ the command shell here in the `env` section:
96
103
}
97
104
```
98
105
106
+ If you are using
107
+ [ Docker] ({{< relref "/integrate/redis-mcp/install#install-using-docker" >}})
108
+ to deploy the server, change the ` command ` and ` args ` sections of the
109
+ configuration as shown below:
110
+
111
+ ``` json
112
+ "redis" : {
113
+ "command" : " docker" ,
114
+ "args" : [" run" ,
115
+ " --rm" ,
116
+ " --name" ,
117
+ " redis-mcp-server" ,
118
+ " -i" ,
119
+ " -e" , " REDIS_HOST=<redis_hostname>" ,
120
+ " -e" , " REDIS_PORT=<redis_port>" ,
121
+ " -e" , " REDIS_USERNAME=<redis_username>" ,
122
+ " -e" , " REDIS_PWD=<redis_password>" ,
123
+ " mcp-redis" ]
124
+ }
125
+ ```
126
+
127
+ ### Remote servers
128
+
129
+ If you set up an
130
+ [ externally visible] ({{< relref "/integrate/redis-mcp/install#making-mcp-visible-externally" >}})
131
+ MCP server, you may be able to configure it directly from the app (but
132
+ if you can't, then see [ Using a gateway] ( #using-a-gateway ) for an alternative approach). For
133
+ example, the following ` JSON ` element configures
134
+ [ Github Copilot for VSCode] ( https://code.visualstudio.com/docs/copilot/overview )
135
+ to use an ` sse ` type server running at ` 127.0.0.1 ` :
136
+
137
+ ``` json
138
+ .
139
+ .
140
+ "mcp" : {
141
+ "servers" : {
142
+ "redis-mcp" : {
143
+ "type" : " sse" ,
144
+ "url" : " http://127.0.0.1:8000/sse"
145
+ },
146
+ }
147
+ },
148
+ .
149
+ .
150
+ ```
151
+
152
+ ### Using a gateway
99
153
154
+ Apps that don't currently support external MCP servers directly, such as Claude
155
+ Desktop, can still access them using a * gateway* . See
156
+ [ MCP server gateway] ( https://github.com/lightconetech/mcp-gateway )
157
+ for more information.
0 commit comments