unsubscribe
Stop receiving messages from a specific Redis channel using this tool. Input the channel name to unsubscribe and receive a confirmation or error response.
Instructions
Unsubscribe from a Redis channel.
Args: channel: The Redis channel to unsubscribe from.
Returns: A success message or an error message.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes |
Implementation Reference
- src/tools/pub_sub.py:45-62 (handler)The main handler function for the 'unsubscribe' tool. It uses Redis pubsub to unsubscribe from the given channel and returns a confirmation message or error.@mcp.tool() async def unsubscribe(channel: str) -> str: """Unsubscribe from a Redis channel. Args: channel: The Redis channel to unsubscribe from. Returns: A success message or an error message. """ try: r = RedisConnectionManager.get_connection() pubsub = r.pubsub() pubsub.unsubscribe(channel) return f"Unsubscribed from channel '{channel}'." except RedisError as e: return f"Error unsubscribing from channel '{channel}': {str(e)}"
- src/tools/pub_sub.py:45-45 (registration)The @mcp.tool() decorator registers the unsubscribe function as an MCP tool.@mcp.tool()
- src/tools/pub_sub.py:45-54 (schema)Input schema defined by function parameter 'channel: str' and output 'str'. Docstring provides additional description.@mcp.tool() async def unsubscribe(channel: str) -> str: """Unsubscribe from a Redis channel. Args: channel: The Redis channel to unsubscribe from. Returns: A success message or an error message. """