awslabs.valkey-mcp-server 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

awslabs/valkey_mcp_server/context.py

@@ -0,0 +1,39 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Context management for Valkey MCP Server."""
+
+
+class Context:
+    """Context class for Valkey MCP Server."""
+
+    _readonly = False
+
+    @classmethod
+    def initialize(cls, readonly: bool = False):
+        """Initialize the context.
+
+        Args:
+            readonly: Whether to run in readonly mode
+        """
+        cls._readonly = readonly
+
+    @classmethod
+    def readonly_mode(cls) -> bool:
+        """Check if the server is running in readonly mode.
+
+        Returns:
+            True if readonly mode is enabled, False otherwise
+        """
+        return cls._readonly

awslabs/valkey_mcp_server/main.py

@@ -14,7 +14,9 @@
 
 """awslabs valkey MCP Server implementation."""
 
+import argparse
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from awslabs.valkey_mcp_server.tools import (
     bitmap,  # noqa: F401
     hash,  # noqa: F401
@@ -56,6 +58,18 @@ class ValkeyMCPServer:
 
 def main():
     """Run the MCP server with CLI argument support."""
+    parser = argparse.ArgumentParser(
+        description='An AWS Labs Model Context Protocol (MCP) server for interacting with Valkey'
+    )
+    parser.add_argument(
+        '--readonly',
+        action=argparse.BooleanOptionalAction,
+        help='Prevents the MCP server from performing mutating operations',
+    )
+
+    args = parser.parse_args()
+    Context.initialize(args.readonly)
+
     logger.info('Amazon ElastiCache/MemoryDB Valkey MCP Server Started...')
 
     server = ValkeyMCPServer()

awslabs/valkey_mcp_server/tools/bitmap.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Optional
 from valkey.exceptions import ValkeyError
 
@@ -32,6 +33,10 @@ async def bitmap_set(key: str, offset: int, value: int) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set bitmap bit in readonly mode'
+
     try:
         if value not in (0, 1):
             return f'Error: value must be 0 or 1, got {value}'

awslabs/valkey_mcp_server/tools/hash.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Dict, Optional, Union
 from valkey.exceptions import ValkeyError
 
@@ -32,6 +33,10 @@ async def hash_set(key: str, field: str, value: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set hash field in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         r.hset(key, field, value)
@@ -51,6 +56,10 @@ async def hash_set_multiple(key: str, mapping: Dict[str, Any]) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set multiple hash fields in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.hset(key, mapping=mapping)
@@ -71,6 +80,10 @@ async def hash_set_if_not_exists(key: str, field: str, value: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set hash field in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.hsetnx(key, field, value)
@@ -153,6 +166,10 @@ async def hash_increment(key: str, field: str, amount: Union[int, float] = 1) ->
     Returns:
         New value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot increment hash field in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         if isinstance(amount, int):

awslabs/valkey_mcp_server/tools/hyperloglog.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from valkey.exceptions import ValkeyError
 
 
@@ -30,6 +31,10 @@ async def hll_add(key: str, element: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot add to HyperLogLog in readonly mode'
+
     try:
         if not element:
             return 'Error: an element is required'

awslabs/valkey_mcp_server/tools/json.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Optional, Union
 from valkey.exceptions import ValkeyError
 
@@ -34,15 +35,13 @@ async def json_set(key: str, path: str, value: Any, nx: bool = False, xx: bool =
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set JSON value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
-        options = {}
-        if nx:
-            options['nx'] = True
-        if xx:
-            options['xx'] = True
-
-        result = r.json().set(key, path, value, **options)
+        result = r.json().set(key, path, value, nx=nx, xx=xx)
         if result:
             return f"Successfully set value at path '{path}' in '{key}'"
         return f"Failed to set value at path '{path}' in '{key}' (path condition not met)"
@@ -121,6 +120,10 @@ async def json_numincrby(key: str, path: str, value: Union[int, float]) -> str:
     Returns:
         New value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot increment JSON value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         # Convert float to int by rounding if needed
@@ -143,6 +146,10 @@ async def json_nummultby(key: str, path: str, value: Union[int, float]) -> str:
     Returns:
         New value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot multiply JSON value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         # Convert float to int by rounding if needed
@@ -165,6 +172,10 @@ async def json_strappend(key: str, path: str, value: str) -> str:
     Returns:
         New string length or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot append to JSON string in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.json().strappend(key, path, value)
@@ -206,6 +217,10 @@ async def json_arrappend(key: str, path: str, *values: Any) -> str:
     Returns:
         New array length or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot append to JSON array in readonly mode'
+
     try:
         if not values:
             return 'Error: at least one value is required'
@@ -285,6 +300,10 @@ async def json_arrpop(key: str, path: str, index: int = -1) -> str:
     Returns:
         Popped value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot pop from JSON array in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.json().arrpop(key, path, index)
@@ -308,6 +327,10 @@ async def json_arrtrim(key: str, path: str, start: int, stop: int) -> str:
     Returns:
         New array length or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot trim JSON array in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.json().arrtrim(key, path, start, stop)
@@ -373,6 +396,10 @@ async def json_toggle(key: str, path: str) -> str:
     Returns:
         New boolean value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot toggle JSON boolean in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.json().toggle(key, path)
@@ -394,6 +421,10 @@ async def json_clear(key: str, path: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot clear JSON container in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.json().clear(key, path)
@@ -415,6 +446,10 @@ async def json_del(key: str, path: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot delete JSON value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.json().delete(key, path)

awslabs/valkey_mcp_server/tools/list.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Optional
 from typing import List as PyList
 from valkey.exceptions import ValkeyError
@@ -32,6 +33,10 @@ async def list_append(key: str, value: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot append to list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.rpush(key, value)
@@ -51,6 +56,10 @@ async def list_prepend(key: str, value: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot prepend to list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.lpush(key, value)
@@ -70,6 +79,10 @@ async def list_append_multiple(key: str, values: PyList[Any]) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot append to list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.rpush(key, *values)
@@ -89,6 +102,10 @@ async def list_prepend_multiple(key: str, values: PyList[Any]) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot prepend to list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.lpush(key, *values)
@@ -130,6 +147,10 @@ async def list_set(key: str, index: int, value: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set list value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         r.lset(key, index, value)
@@ -172,6 +193,10 @@ async def list_trim(key: str, start: int, stop: int) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot trim list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         r.ltrim(key, start, stop)
@@ -209,6 +234,10 @@ async def list_pop_left(key: str, count: Optional[int] = None) -> str:
     Returns:
         Value(s) or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot pop from list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         if count:
@@ -233,6 +262,10 @@ async def list_pop_right(key: str, count: Optional[int] = None) -> str:
     Returns:
         Value(s) or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot pop from list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         if count:
@@ -299,6 +332,10 @@ async def list_move(
     Returns:
         Moved value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot move list elements in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         wherefrom = wherefrom.upper()
@@ -327,6 +364,10 @@ async def list_insert_before(key: str, pivot: Any, value: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot insert into list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.linsert(key, 'BEFORE', pivot, value)
@@ -349,6 +390,10 @@ async def list_insert_after(key: str, pivot: Any, value: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot insert into list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.linsert(key, 'AFTER', pivot, value)
@@ -371,6 +416,10 @@ async def list_remove(key: str, value: Any, count: int = 0) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot remove from list in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.lrem(key, count, value)

awslabs/valkey_mcp_server/tools/misc.py

@@ -14,6 +14,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Dict
 from valkey.exceptions import ValkeyError as RedisError
 
@@ -28,6 +29,10 @@ async def delete(key: str) -> str:
     Returns:
         str: Confirmation message or an error message.
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot delete key in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.delete(key)
@@ -67,6 +72,10 @@ async def expire(name: str, expire_seconds: int) -> str:
     Returns:
         A success message or an error message.
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set expiration in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         success = r.expire(name, expire_seconds)
@@ -92,6 +101,10 @@ async def rename(old_key: str, new_key: str) -> Dict[str, Any]:
             On success: {"status": "success", "message": "..."}
             On error: {"error": "..."}
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return {'error': 'Cannot rename key in readonly mode'}
+
     try:
         r = ValkeyConnectionManager.get_connection()
 

awslabs/valkey_mcp_server/tools/set.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Optional
 from valkey.exceptions import ValkeyError
 
@@ -31,6 +32,10 @@ async def set_add(key: str, member: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot add to set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.sadd(key, member)
@@ -50,6 +55,10 @@ async def set_remove(key: str, member: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot remove from set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.srem(key, member)
@@ -69,6 +78,10 @@ async def set_pop(key: str, count: Optional[int] = None) -> str:
     Returns:
         Popped member(s) or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot pop from set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         if count:
@@ -94,6 +107,10 @@ async def set_move(source: str, destination: str, member: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot move set members in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.smove(source, destination, member)

awslabs/valkey_mcp_server/tools/sorted_set.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Dict, Optional
 from valkey.exceptions import ValkeyError
 
@@ -31,6 +32,10 @@ async def sorted_set_add(key: str, mapping: Dict[Any, float]) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot add to sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.zadd(key, mapping)
@@ -51,6 +56,10 @@ async def sorted_set_add_incr(key: str, member: Any, score: float) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot increment score in sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.zincrby(key, score, member)
@@ -70,6 +79,10 @@ async def sorted_set_remove(key: str, *members: Any) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot remove from sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.zrem(key, *members)
@@ -90,6 +103,10 @@ async def sorted_set_remove_by_rank(key: str, start: int, stop: int) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot remove from sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.zremrangebyrank(key, start, stop)
@@ -110,6 +127,10 @@ async def sorted_set_remove_by_score(key: str, min_score: float, max_score: floa
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot remove from sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.zremrangebyscore(key, min_score, max_score)
@@ -130,6 +151,10 @@ async def sorted_set_remove_by_lex(key: str, min_lex: str, max_lex: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot remove from sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.zremrangebylex(key, min_lex, max_lex)
@@ -325,6 +350,10 @@ async def sorted_set_popmin(key: str, count: Optional[int] = None) -> str:
     Returns:
         Popped members with scores or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot pop from sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         if count:
@@ -349,6 +378,10 @@ async def sorted_set_popmax(key: str, count: Optional[int] = None) -> str:
     Returns:
         Popped members with scores or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot pop from sorted set in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         if count:

awslabs/valkey_mcp_server/tools/stream.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Dict, Optional
 from valkey.exceptions import ValkeyError
 
@@ -40,6 +41,10 @@ async def stream_add(
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot add to stream in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         options = {}
@@ -66,6 +71,10 @@ async def stream_delete(key: str, id: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot delete from stream in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.xdel(key, id)
@@ -86,6 +95,10 @@ async def stream_trim(key: str, maxlen: int, approximate: bool = True) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot trim stream in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.xtrim(key, maxlen=maxlen, approximate=approximate)
@@ -183,6 +196,10 @@ async def stream_group_create(
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot create consumer group in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         r.xgroup_create(key, group_name, id=id, mkstream=mkstream)
@@ -202,6 +219,10 @@ async def stream_group_destroy(key: str, group_name: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot destroy consumer group in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.xgroup_destroy(key, group_name)
@@ -224,6 +245,10 @@ async def stream_group_set_id(key: str, group_name: str, id: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set consumer group ID in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         r.xgroup_setid(key, group_name, id)
@@ -244,6 +269,10 @@ async def stream_group_delete_consumer(key: str, group_name: str, consumer_name:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot delete consumer in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.xgroup_delconsumer(key, group_name, consumer_name)
@@ -274,6 +303,10 @@ async def stream_read_group(
     Returns:
         List of entries or error message
     """
+    # Check if readonly mode is enabled and acknowledgment is required
+    if Context.readonly_mode() and not noack:
+        return 'Error: Cannot read from stream with acknowledgment in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         streams = {key: '>'}  # ">" means read undelivered entries

awslabs/valkey_mcp_server/tools/string.py

@@ -16,6 +16,7 @@
 
 from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
 from awslabs.valkey_mcp_server.common.server import mcp
+from awslabs.valkey_mcp_server.context import Context
 from typing import Any, Optional
 from valkey.exceptions import ValkeyError
 
@@ -44,6 +45,10 @@ async def string_set(
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set string value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.set(key, value, ex=ex, px=px, nx=nx, xx=xx, keepttl=keepttl)
@@ -85,6 +90,10 @@ async def string_append(key: str, value: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot append to string value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.append(key, value)
@@ -126,6 +135,10 @@ async def string_get_set(key: str, value: Any) -> str:
     Returns:
         Old value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set string value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.getset(key, value)
@@ -147,6 +160,10 @@ async def string_increment(key: str, amount: int = 1) -> str:
     Returns:
         New value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot increment string value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.incrby(key, amount)
@@ -166,6 +183,10 @@ async def string_increment_float(key: str, amount: float) -> str:
     Returns:
         New value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot increment float string value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.incrbyfloat(key, amount)
@@ -185,6 +206,10 @@ async def string_decrement(key: str, amount: int = 1) -> str:
     Returns:
         New value or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot decrement string value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.decrby(key, amount)
@@ -223,6 +248,10 @@ async def string_set_range(key: str, offset: int, value: str) -> str:
     Returns:
         Success message or error message
     """
+    # Check if readonly mode is enabled
+    if Context.readonly_mode():
+        return 'Error: Cannot set range in string value in readonly mode'
+
     try:
         r = ValkeyConnectionManager.get_connection()
         result = r.setrange(key, offset, value)

{awslabs_valkey_mcp_server-1.0.2.dist-info → awslabs_valkey_mcp_server-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awslabs.valkey-mcp-server
-Version: 1.0.2
+Version: 1.0.3
 Summary: An AWS Labs Model Context Protocol (MCP) server for valkey
 Project-URL: homepage, https://awslabs.github.io/mcp/
 Project-URL: docs, https://awslabs.github.io/mcp/servers/valkey-mcp-server/
@@ -50,6 +50,7 @@ This MCP server provides tools to operate on Valkey data types. For example, it
 - **Cluster Support**: Support for standalone and clustered Valkey deployments.
 - **SSL/TLS Security**: Configure secure connections using SSL/TLS.
 - **Connection Pooling**: Pools connections by default to enable efficient connection management.
+- **Readonly Mode**: Prevent write operations to ensure data safety.
 
 ## Prerequisites
 
@@ -61,6 +62,8 @@ This MCP server provides tools to operate on Valkey data types. For example, it
 
 ## Installation
 
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=awslabs.valkey-mcp-server&config=eyJjb21tYW5kIjoidXZ4IGF3c2xhYnMudmFsa2V5LW1jcC1zZXJ2ZXJAbGF0ZXN0IiwiZW52Ijp7IlZBTEtFWV9IT1NUIjoiMTI3LjAuMC4xIiwiVkFMS0VZX1BPUlQiOiI2Mzc5IiwiRkFTVE1DUF9MT0dfTEVWRUwiOiJFUlJPUiJ9LCJhdXRvQXBwcm92ZSI6W10sImRpc2FibGVkIjpmYWxzZX0%3D)
+
 Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q Developer CLI MCP, `~/.aws/amazonq/mcp.json`):
 
 ```json
@@ -83,6 +86,29 @@ Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q De
 }
 ```
 
+To run in readonly mode:
+
+```json
+{
+  "mcpServers": {
+    "awslabs.valkey-mcp-server": {
+      "command": "uvx",
+      "args": [
+        "awslabs.valkey-mcp-server@latest",
+        "--readonly"
+      ],
+      "env": {
+        "VALKEY_HOST": "127.0.0.1",
+        "VALKEY_PORT": "6379",
+        "FASTMCP_LOG_LEVEL": "ERROR"
+      },
+      "autoApprove": [],
+      "disabled": false
+    }
+  }
+}
+```
+
 Or using Docker after a successful `docker build -t awslabs/valkey-mcp-server .`:
 
 ```json
@@ -110,6 +136,34 @@ Or using Docker after a successful `docker build -t awslabs/valkey-mcp-server .`
 }
 ```
 
+To run in readonly mode with Docker:
+
+```json
+{
+  "mcpServers": {
+    "awslabs.valkey-mcp-server": {
+      "command": "docker",
+      "args": [
+        "run",
+        "--rm",
+        "--interactive",
+        "--env",
+        "FASTMCP_LOG_LEVEL=ERROR",
+        "--env",
+        "VALKEY_HOST=127.0.0.1",
+        "--env",
+        "VALKEY_PORT=6379",
+        "awslabs/valkey-mcp-server:latest",
+        "--readonly"
+      ],
+      "env": {},
+      "disabled": false,
+      "autoApprove": []
+    }
+  }
+}
+```
+
 ## Configuration
 
 The server can be configured using the following environment variables:
@@ -163,3 +217,11 @@ docker run -p 8080:8080 \
   -e VALKEY_PORT=6379 \
   awslabs/valkey-mcp-server
 ```
+
+To run in readonly mode:
+```bash
+docker run -p 8080:8080 \
+  -e VALKEY_HOST=host.docker.internal \
+  -e VALKEY_PORT=6379 \
+  awslabs/valkey-mcp-server --readonly
+```

awslabs_valkey_mcp_server-1.0.3.dist-info/RECORD

@@ -0,0 +1,27 @@
+awslabs/__init__.py,sha256=WuqxdDgUZylWNmVoPKiK7qGsTB_G4UmuXIrJ-VBwDew,731
+awslabs/valkey_mcp_server/__init__.py,sha256=C2RgjQfy3kYBZ2NokGTW308ldYQNXPJOmcifIoSqxqY,672
+awslabs/valkey_mcp_server/context.py,sha256=SSiXTebscjQ4_7q0Sa6CMRd2BS2NWjiF02koIFKfhX0,1202
+awslabs/valkey_mcp_server/main.py,sha256=akwmYY1H5EAsIbmHG9rpVsxn17a-kRzTsa5X7Ki-Wq4,2446
+awslabs/valkey_mcp_server/version.py,sha256=8161BBQQZut_MCnIZdhSJ3B_abfx8cwaKu90EaS__Dw,638
+awslabs/valkey_mcp_server/common/__init__.py,sha256=-c4-Il6p3y3Ds9yZv58p1CHT_p8yO9a6n4wzHEVAFG4,699
+awslabs/valkey_mcp_server/common/config.py,sha256=swcXMANStSJRZGuuHFLFMJckccH88c7HEg2QruzX-Pg,3154
+awslabs/valkey_mcp_server/common/connection.py,sha256=twCbzkIWoc9BCx8TIViJ6m-c9eRNv5tCIQmntd6crOk,4044
+awslabs/valkey_mcp_server/common/server.py,sha256=3cGdifWvtk93fenC_IJ4KD0sBfPr0myPURp6igRK0pQ,1148
+awslabs/valkey_mcp_server/tools/__init__.py,sha256=yAdR7sNlUZwYaqOBba_KLN7qdxsO29PglZnSKsXpsTw,820
+awslabs/valkey_mcp_server/tools/bitmap.py,sha256=aeKjYyAjTDVW5e9kTN1zKV7zCSEB8h42Dfjn27P1A_U,5225
+awslabs/valkey_mcp_server/tools/hash.py,sha256=q4vMzgVH3rnHkzcfttnE2qcdQ4iEXDFL0WCV14wLfAc,8649
+awslabs/valkey_mcp_server/tools/hyperloglog.py,sha256=uydzWwNyivtz0xcMYwKSS5fqS20lNB1iR7wxVUXQvec,2182
+awslabs/valkey_mcp_server/tools/json.py,sha256=Yke-cj9gu_XKryymbChsb5nMu1rkWrGV7GdCxL4H1CQ,15189
+awslabs/valkey_mcp_server/tools/list.py,sha256=Vjs2BA3UWMvmmK_k_U1EeCFkjzcl7z51E5RbBJbnHUY,13032
+awslabs/valkey_mcp_server/tools/misc.py,sha256=3OCCnjkQmM8RBfpj91rr-ENGXq9IidEey20vgZG96yk,3830
+awslabs/valkey_mcp_server/tools/server_management.py,sha256=wL_q_eADfvN6F8VrU5pwXvyVdCL4WFZ4PICm2PDPq14,1955
+awslabs/valkey_mcp_server/tools/set.py,sha256=ZSWmFgvVg7VgVrAQiNg9KAuZD1_wWiFYKgG1QVsHWnw,5824
+awslabs/valkey_mcp_server/tools/sorted_set.py,sha256=lEJLikzltYQIl4qZH61Adki8Gaeiv1nLjDxngK0PERs,12555
+awslabs/valkey_mcp_server/tools/stream.py,sha256=o2gn69xUFpf3Zg32xTsaO0c_Ibaspv7XS67NpVtukmk,11687
+awslabs/valkey_mcp_server/tools/string.py,sha256=W0gMxfIli-gWr_RL67tnKrZJ4QMlCJViAeZxbgbFQII,7486
+awslabs_valkey_mcp_server-1.0.3.dist-info/METADATA,sha256=2Zo8LgmeImknI5VNtXm73kdQQ4OpGRAwv14_VxzYGAE,7171
+awslabs_valkey_mcp_server-1.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+awslabs_valkey_mcp_server-1.0.3.dist-info/entry_points.txt,sha256=pOqhzh9mlelNc6dLngnCQS1bs62Wazi0Y8EqQmXolK0,82
+awslabs_valkey_mcp_server-1.0.3.dist-info/licenses/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
+awslabs_valkey_mcp_server-1.0.3.dist-info/licenses/NOTICE,sha256=02_lxJlcwNuKRYtdONbI4i4RBK09-SqoQCzkqjpbqhY,93
+awslabs_valkey_mcp_server-1.0.3.dist-info/RECORD,,

awslabs_valkey_mcp_server-1.0.2.dist-info/RECORD

@@ -1,26 +0,0 @@
-awslabs/__init__.py,sha256=WuqxdDgUZylWNmVoPKiK7qGsTB_G4UmuXIrJ-VBwDew,731
-awslabs/valkey_mcp_server/__init__.py,sha256=C2RgjQfy3kYBZ2NokGTW308ldYQNXPJOmcifIoSqxqY,672
-awslabs/valkey_mcp_server/main.py,sha256=lXPGVljjwMTDWuaJoP3cUij1rebdQE73v7s8cgn3R1s,1987
-awslabs/valkey_mcp_server/version.py,sha256=8161BBQQZut_MCnIZdhSJ3B_abfx8cwaKu90EaS__Dw,638
-awslabs/valkey_mcp_server/common/__init__.py,sha256=-c4-Il6p3y3Ds9yZv58p1CHT_p8yO9a6n4wzHEVAFG4,699
-awslabs/valkey_mcp_server/common/config.py,sha256=swcXMANStSJRZGuuHFLFMJckccH88c7HEg2QruzX-Pg,3154
-awslabs/valkey_mcp_server/common/connection.py,sha256=twCbzkIWoc9BCx8TIViJ6m-c9eRNv5tCIQmntd6crOk,4044
-awslabs/valkey_mcp_server/common/server.py,sha256=3cGdifWvtk93fenC_IJ4KD0sBfPr0myPURp6igRK0pQ,1148
-awslabs/valkey_mcp_server/tools/__init__.py,sha256=yAdR7sNlUZwYaqOBba_KLN7qdxsO29PglZnSKsXpsTw,820
-awslabs/valkey_mcp_server/tools/bitmap.py,sha256=v2bnWfbnoVaEaN6j6Nmdz0eWapnLhVbYq_wteOjQub8,5035
-awslabs/valkey_mcp_server/tools/hash.py,sha256=9fMUnXDXovukFpVVYkCCetEhyaBfotymuNmrAmpEbZo,8035
-awslabs/valkey_mcp_server/tools/hyperloglog.py,sha256=rs5PrS6xQHiuuG5mc1pwJSrSj8ECv-X5MjrTNzVEqds,1988
-awslabs/valkey_mcp_server/tools/json.py,sha256=yWr3UgHR1xTrkLTr77JbePQQdHlenMVyf1sRcOVKt00,13846
-awslabs/valkey_mcp_server/tools/list.py,sha256=zFxEm3f6X_3skLUAtQNzmQ1_Yk3NXlfpVHk0R_nzPfw,11341
-awslabs/valkey_mcp_server/tools/misc.py,sha256=QglRL6SBgUMudMlKQ3HovG2EUgYaQb6W7uH63djTFQA,3372
-awslabs/valkey_mcp_server/tools/server_management.py,sha256=wL_q_eADfvN6F8VrU5pwXvyVdCL4WFZ4PICm2PDPq14,1955
-awslabs/valkey_mcp_server/tools/set.py,sha256=aSzb4mzNCgm35UTUE3u1dMOr4_IfQSHZrnnRias72og,5229
-awslabs/valkey_mcp_server/tools/sorted_set.py,sha256=ZTwaKwopJVAL8nSN6a8nHs82gnw-e-ynDhwInSXLVlg,11353
-awslabs/valkey_mcp_server/tools/stream.py,sha256=YdwDsqKRKExdxY_wlXFP-6R_YMYww8Qxf7D2zpeo1_0,10455
-awslabs/valkey_mcp_server/tools/string.py,sha256=ip04esz_3VriS5h2J8yCqz_SdpnGxSwEbaqwqVe6fe4,6427
-awslabs_valkey_mcp_server-1.0.2.dist-info/METADATA,sha256=Lw0G01bwho2ro20CQSzkxpVFUH6drrE6rFalw31iZJs,5661
-awslabs_valkey_mcp_server-1.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-awslabs_valkey_mcp_server-1.0.2.dist-info/entry_points.txt,sha256=pOqhzh9mlelNc6dLngnCQS1bs62Wazi0Y8EqQmXolK0,82
-awslabs_valkey_mcp_server-1.0.2.dist-info/licenses/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
-awslabs_valkey_mcp_server-1.0.2.dist-info/licenses/NOTICE,sha256=02_lxJlcwNuKRYtdONbI4i4RBK09-SqoQCzkqjpbqhY,93
-awslabs_valkey_mcp_server-1.0.2.dist-info/RECORD,,