{
  "schema_version": 2,
  "id": "integrate/redis-mcp/client-conf",
  "title": "Configure client apps",
  "url": "https://redis.io/docs/latest/integrate/redis-mcp/client-conf/",
  "summary": "Configure client apps to use the Redis MCP server.",
  "aliases": [
    "/integrate/redis-mcp/ciient-conf/"
  ],
  "tags": [
    "docs",
    "integrate",
    "rs"
  ],
  "last_updated": "2026-09-17T14:55:03+01:00",
  "page_type": "content",
  "content_hash": "fea47094f2158a31dfea8569b8adce70da20f2dca8d1c8abf8c6a09fb7303107",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "When you have [installed](https://redis.io/docs/latest/integrate/redis-mcp/install)\nthe Redis MCP server, you must also configure your client app to use it.\nThe sections below describe the ways you can do this."
    },
    {
      "id": "smithery",
      "title": "Smithery",
      "role": "content",
      "text": "[Smithery](https://smithery.ai/) provides a searchable repository of scripts\nthat add configurations for many MCP services to client apps.\nThe easiest way to configure your client is to use the\n[Smithery tool for Redis MCP](https://smithery.ai/server/@redis/mcp-redis).\n\nWhen you select your client from the **Install** bar on the Redis MCP page,\nyou will see a command line that you can copy and paste into a terminal.\nRunning this command will configure your client app to use Redis MCP. (Note\nthat you must have [Node.js](https://nodejs.org/en) installed to run\nthe Smithery scripts.) For example, the command line for\n[Claude Desktop](https://claude.ai/download) is\n\n[code example]\n\nThe script will prompt you for the information required to connect to\nyour Redis database."
    },
    {
      "id": "manual-configuration",
      "title": "Manual configuration",
      "role": "content",
      "text": "You can also add the configuration for Redis MCP to your client app\nmanually. The exact method varies from client to client but the\nbasic approach is similar in each case. The sections below\ngive the general configuration details for some common MCP client tools:\n\n-   [Augment Code](#augment-code)\n-   [Claude Desktop](#claude-desktop)\n-   [OpenAI Agents](#openai-agents)\n-   [VS Code with GitHub Copilot](#vs-code-with-github-copilot)"
    },
    {
      "id": "augment-code",
      "title": "Augment Code",
      "role": "content",
      "text": "Redis supports Augment Code's\n[Easy MCP](https://docs.augmentcode.com/setup-augment/mcp#easy-mcp%3A-one-click-integrations)\nfeature in [VSCode](https://docs.augmentcode.com/setup-augment/mcp#getting-started-with-easy-mcp)\nand the [JetBrains IDEs](https://docs.augmentcode.com/jetbrains/setup-augment/mcp#getting-started-with-easy-mcp)\nto install the server in seconds:\n\n1.  Open the Augment settings panel and\n    navigate to the **MCP** pane.\n1.  Click the \"+\" button next to Redis in the\n    **Easy MCP installation** list and enter the connection details for your Redis database.\n1.  Click **Install** to start using Redis MCP.\n\nIf you need to supply environment variables or command line parameters:\n\n1.  Click the **Add MCP** button underneath the list of Easy MCP integrations.\n1.  Enter `Redis` in the name field and paste the appropriate command line in the\n    command field (see \n    [Configuration](https://redis.io/docs/latest/integrate/redis-mcp/install#configuration) for\n    more information about the available command line options).\n1.  Click the **+ Variable** button to add any environment variables that you need.\n1.  Click **Add** to add the server."
    },
    {
      "id": "claude-desktop",
      "title": "Claude Desktop",
      "role": "content",
      "text": "First, locate the configuration file by selecting **Settings** from the menu, then selecting the **Developer** tab, and then clicking the **Edit Config** button. Open this JSON file and add your settings as shown below to run Redis MCP with [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools):\n\n[code example]\n\nYou can also optionally set the environment for the command shell here in the\n`env` section:\n\n[code example]\n\nIf you are using\n[Docker](https://redis.io/docs/latest/integrate/redis-mcp/install#install-using-docker)\nto deploy the server, change the `command` and `args` sections of the\nconfiguration as shown below:\n\n[code example]\n\nFor more information about using MCP with Claude Desktop, see\n[Connect to Local MCP Servers](https://modelcontextprotocol.io/quickstart/user)."
    },
    {
      "id": "openai-agents",
      "title": "OpenAI Agents",
      "role": "content",
      "text": "The\n[`redis_assistant.py`](https://github.com/redis/mcp-redis/blob/main/examples/redis_assistant.py)\nfile in the [`mcp-redis`](https://github.com/redis/mcp-redis) repository contains an\nexample of how to configure OpenAI Agents to use Redis MCP.\n\nTo use this example, install the `openai-agents` library, ensure\nyou have exported the OpenAI token in the `OPENAI_API_KEY` environment variable\nand run the `redis_assistant.py` script:\n\n[code example]\n\nSee the\n[OpenAI Agents SDK documentation](https://openai.github.io/openai-agents-python/mcp/)\nfor more information about using MCP servers."
    },
    {
      "id": "vs-code-with-github-copilot",
      "title": "VS Code with GitHub Copilot",
      "role": "content",
      "text": "To use Redis MCP with VS Code, first add the following to your `settings.json`\nfile to enable the\n[agent mode tools](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode):\n\n[code example]\n\nThen, add the following lines to `settings.json` to run Redis MCP\nwith [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools):\n\n[code example]\n\nYou can also add\n[environment variables](https://redis.io/docs/latest/integrate/redis-mcp/install#environment-variables) \nin the `env` section of the configuration:\n\n[code example]\n\nSee\n[Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)\nfor more information."
    },
    {
      "id": "redis-cloud-mcp",
      "title": "Redis Cloud MCP",
      "role": "content",
      "text": "If you are using\n[Redis Cloud MCP](https://redis.io/docs/latest/integrate/redis-mcp/install#redis-cloud-mcp),\nthe configuration is similar to [basic MCP](#manual-configuration), but with a\nfew differences. Set the client to run the server using the `node` command, as shown \nin the example for Claude Desktop below:\n\n[code example]\n\nHere, the environment includes the Redis Cloud API key and API secret key\n(see [Redis Cloud REST API](https://redis.io/docs/latest/operate/rc/api) for more\ninformation).\n\nIf you are deploying Redis Cloud MCP with Docker, use a configuration like\nthe following to launch the server with the `docker` command:\n\n[code example]"
    }
  ],
  "examples": [
    {
      "id": "smithery-ex0",
      "language": "bash",
      "code": "npx -y @smithery/cli@latest install @redis/mcp-redis --client claude",
      "section_id": "smithery"
    },
    {
      "id": "claude-desktop-ex0",
      "language": "json",
      "code": "{\n    \"mcpServers\": {\n        .\n        .\n        \"redis-mcp-server\": {\n            \"type\": \"stdio\",\n            \"command\": \"uvx\",\n            \"args\": [\n                \"--from\", \"redis-mcp-server@latest\",\n                \"redis-mcp-server\",\n                \"--url\", \"redis://localhost:6379/0\"\n            ]\n        }\n    }\n        .\n        .\n  }",
      "section_id": "claude-desktop"
    },
    {
      "id": "claude-desktop-ex1",
      "language": "json",
      "code": "\"redis\": {\n    \"type\": \"stdio\",\n    \"command\": \"uvx\",\n    \"args\": [\n        \"--from\", \"redis-mcp-server@latest\",\n        \"redis-mcp-server\",\n        \"--url\", \"redis://localhost:6379/0\"\n    ],\n    \"env\": {\n        \"REDIS_HOST\": \"<your_redis_database_hostname>\",\n        \"REDIS_PORT\": \"<your_redis_database_port>\",\n        \"REDIS_PWD\": \"<your_redis_database_password>\",\n        \"REDIS_SSL\": True|False,\n        \"REDIS_CA_PATH\": \"<your_redis_ca_path>\",\n        \"REDIS_CLUSTER_MODE\": True|False\n    }\n}",
      "section_id": "claude-desktop"
    },
    {
      "id": "claude-desktop-ex2",
      "language": "json",
      "code": "\"redis\": {\n    \"command\": \"docker\",\n    \"args\": [\"run\",\n            \"--rm\",\n            \"--name\",\n            \"redis-mcp-server\",\n            \"-i\",\n            \"-e\", \"REDIS_HOST=<redis_hostname>\",\n            \"-e\", \"REDIS_PORT=<redis_port>\",\n            \"-e\", \"REDIS_USERNAME=<redis_username>\",\n            \"-e\", \"REDIS_PWD=<redis_password>\",\n            \"mcp-redis\"]\n}",
      "section_id": "claude-desktop"
    },
    {
      "id": "openai-agents-ex0",
      "language": "bash",
      "code": "pip install openai-agents\nexport OPENAI_API_KEY=<your_openai_api_key>\npython3 redis_assistant.py",
      "section_id": "openai-agents"
    },
    {
      "id": "vs-code-with-github-copilot-ex0",
      "language": "json",
      "code": "{\n  \"chat.agent.enabled\": true\n}",
      "section_id": "vs-code-with-github-copilot"
    },
    {
      "id": "vs-code-with-github-copilot-ex1",
      "language": "json",
      "code": ".\n  .\n\"mcp\": {\n    \"servers\": {\n        \"Redis MCP Server\": {\n        \"type\": \"stdio\",\n        \"command\": \"uvx\", \n        \"args\": [\n            \"--from\", \"redis-mcp-server@latest\",\n            \"redis-mcp-server\",\n            \"--url\", \"redis://localhost:6379/0\"\n        ]\n        },\n    }\n},\n  .\n  .",
      "section_id": "vs-code-with-github-copilot"
    },
    {
      "id": "vs-code-with-github-copilot-ex2",
      "language": "json",
      "code": "\"Redis MCP Server\": {\n    .\n    .\n  \"env\": {\n    \"REDIS_HOST\": \"<your_redis_database_hostname>\",\n    \"REDIS_PORT\": \"<your_redis_database_port>\",\n    \"REDIS_USERNAME\": \"<your_redis_database_username>\",\n    \"REDIS_PWD\": \"<your_redis_database_password>\",\n      .\n      .\n  }\n}",
      "section_id": "vs-code-with-github-copilot"
    },
    {
      "id": "redis-cloud-mcp-ex0",
      "language": "json",
      "code": "{\n  \"mcpServers\": {\n    \"mcp-redis-cloud\": {\n      \"command\": \"node\",\n      \"args\": [\"--experimental-fetch\", \"<absolute_path_to_project_root>/dist/index.js\"],\n      \"env\": {\n        \"API_KEY\": \"<redis_cloud_api_key>\",\n        \"SECRET_KEY\": \"<redis_cloud_api_secret_key>\"\n      }\n    }\n  }\n}",
      "section_id": "redis-cloud-mcp"
    },
    {
      "id": "redis-cloud-mcp-ex1",
      "language": "json",
      "code": "{\n  \"mcpServers\": {\n    \"redis-cloud\": {\n      \"command\": \"docker\",\n      \"args\": [\n        \"run\",\n        \"-i\",\n        \"--rm\",\n        \"-e\",\n        \"API_KEY=<your_redis_cloud_api_key>\",\n        \"-e\",\n        \"SECRET_KEY=<your_redis_cloud_api_secret_key>\",\n        \"mcp/redis-cloud\"\n      ]\n    }\n  }\n}",
      "section_id": "redis-cloud-mcp"
    }
  ]
}