README file

Author: mortensi

README.md

@@ -1 +1,91 @@
-# mcp-redis
+# Redis MCP Server
+
+## Overview
+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.
+
+## Features
+- **Natural Language Queries**: Enables AI agents to query and update Redis using natural language.
+- **Seamless MCP Integration**: Works with any **MCP client** for smooth communication.
+- **Full Redis Support**: Handles **hashes, lists, sets, sorted sets, streams**, and more.
+- **Search & Filtering**: Supports efficient data retrieval and searching in Redis.
+- **Scalable & Lightweight**: Designed for **high-performance** data operations.
+
+## Installation
+```sh
+# Clone the repository
+git clone https://github.com/redis/mcp-redis.git
+cd mcp-redis
+
+# Install dependencies using uv
+uv venv
+source .venv/bin/activate
+uv sync
+```
+
+## Usage
+Start the MCP Redis Server:
+```sh
+python src/main.py
+```
+
+Configure Claude Desktop to use this MCP Server by editing the `claude_desktop_config.json` configuration file.
+
+1. Specify your Redis credentials and TLS configuration
+2. Retrieve your `uv` command full path (e.g. `which uv`)
+3. Edit the configuration file at `~/Library/Application\ Support/Claude/claude_desktop_config.json`
+
+```commandline
+{
+    "mcpServers": {
+        "redis": {
+            "command": "<full_path_uv_command>",
+            "args": [
+                "--directory",
+                "<your_mcp_server_directory>",
+                "run",
+                "src/main.py"
+            ],
+            "env": {
+                "REDIS_HOST": "<your_redis_database_hostname>",
+                "REDIS_PORT": "<your_redis_database_port>",
+                "REDIS_PSW": "<your_redis_database_password>",
+                "REDIS_SSL": True|False,
+                "REDIS_CA_PATH": "<your_redis_ca_path>"
+            }
+        }
+    }
+}
+```
+
+You can troubleshoot any problem by tailing the log file.
+
+```commandline
+tail -f ~/Library/Logs/Claude/mcp-server-redis.log
+```
+
+## Testing
+
+You can use the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) for visual debugging of this MCP Server.
+
+```sh
+npx @modelcontextprotocol/inspector uv run src/main.py
+```
+
+## Example Use Cases
+- **AI Assistants**: Enable LLMs to fetch, store, and process data in Redis.
+- **Chatbots & Virtual Agents**: Retrieve session data, manage queues, and personalize responses.
+- **Data Search & Analytics**: Query Redis for **real-time insights and fast lookups**.
+- **Event Processing**: Manage event streams with **Redis Streams**.
+
+## Contributing
+1. Fork the repo
+2. Create a new branch (`feature-branch`)
+3. Commit your changes
+4. Push to your branch and submit a PR!
+
+## License
+This project is licensed under the **MIT License**.
+
+## Contact
+For questions or support, reach out via [GitHub Issues](https://github.com/redis/mcp-redis-server/issues).
+

pyproject.toml

@@ -7,6 +7,5 @@ requires-python = ">=3.13"
 dependencies = [
     "mcp[cli]>=1.5.0",
     "redis>=5.2.1",
-    "pydantic-settings>=2.0.0",
     "dotenv>=0.9.9",
 ]