| 1 | # Redis MCP Server |
| 2 | |
| 3 | <!-- mcp-name: io.github.redis/mcp-redis --> |
| 4 | |
| 5 | [](https://github.com/redis/mcp-redis/actions/workflows/ci.yml) |
| 6 | [](https://pypi.org/project/redis-mcp-server/) |
| 7 | [](https://www.python.org/downloads/) |
| 8 | [](./LICENSE.txt) |
| 9 | [](https://mseep.ai/app/70102150-efe0-4705-9f7d-87980109a279) |
| 10 | [](https://hub.docker.com/r/mcp/redis) |
| 11 | [](https://codecov.io/gh/redis/mcp-redis) |
| 12 | |
| 13 | |
| 14 | [](https://discord.gg/redis) |
| 15 | [](https://www.twitch.tv/redisinc) |
| 16 | [](https://www.youtube.com/redisinc) |
| 17 | [](https://twitter.com/redisinc) |
| 18 | [](https://stackoverflow.com/questions/tagged/mcp-redis) |
| 19 | |
| 20 | ## Overview |
| 21 | 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: |
| 22 | |
| 23 | - "Store the entire conversation in a stream" |
| 24 | - "Cache this item" |
| 25 | - "Store the session with an expiration time" |
| 26 | - "Index and search this vector" |
| 27 | |
| 28 | ## Table of Contents |
| 29 | - [Overview](#overview) |
| 30 | - [Features](#features) |
| 31 | - [Tools](#tools) |
| 32 | - [Installation](#installation) |
| 33 | - [From PyPI (recommended)](#from-pypi-recommended) |
| 34 | - [Testing the PyPI package](#testing-the-pypi-package) |
| 35 | - [From GitHub](#from-github) |
| 36 | - [Development Installation](#development-installation) |
| 37 | - [With Docker](#with-docker) |
| 38 | - [Configuration](#configuration) |
| 39 | - [Redis ACL](#redis-acl) |
| 40 | - [Configuration via command line arguments](#configuration-via-command-line-arguments) |
| 41 | - [Configuration via Environment Variables](#configuration-via-environment-variables) |
| 42 | - [EntraID Authentication for Azure Managed Redis](#entraid-authentication-for-azure-managed-redis) |
| 43 | - [Logging](#logging) |
| 44 | - [Integrations](#integrations) |
| 45 | - [OpenAI Agents SDK](#openai-agents-sdk) |
| 46 | - [Augment](#augment) |
| 47 | - [Claude Desktop](#claude-desktop) |
| 48 | - [VS Code with GitHub Copilot](#vs-code-with-github-copilot) |
| 49 | - [Testing](#testing) |
| 50 | - [Example Use Cases](#example-use-cases) |
| 51 | - [Contributing](#contributing) |
| 52 | - [License](#license) |
| 53 | - [Badges](#badges) |
| 54 | - [Contact](#contact) |
| 55 | |
| 56 | |
| 57 | ## Features |
| 58 | - **Natural Language Queries**: Enables AI agents to query and update Redis using natural language. |
| 59 | - **Seamless MCP Integration**: Works with any **MCP client** for smooth communication. |
| 60 | - **Full Redis Support**: Handles **hashes, lists, sets, sorted sets, streams**, and more. |
| 61 | - **Search & Filtering**: Supports efficient data retrieval and searching in Redis. |
| 62 | - **Scalable & Lightweight**: Designed for **high-performance** data operations. |
| 63 | - **EntraID Authentication**: Native support for Azure Active Directory authentication with Azure Managed Redis. |
| 64 | - The Redis MCP Server supports the `stdio` [transport](https://modelcontextprotocol.io/docs/concepts/transports#standard-input%2Foutput-stdio). Support to the `stremable-http` transport will be added in the future. |
| 65 | |
| 66 | ## Tools |
| 67 | |
| 68 | This MCP Server prov |