awslabs.valkey-mcp-server 1.0.2__tar.gz → 1.0.3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/PKG-INFO +63 -1
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/README.md +62 -0
- awslabs_valkey_mcp_server-1.0.3/awslabs/valkey_mcp_server/context.py +39 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/main.py +14 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/bitmap.py +5 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/hash.py +17 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/hyperloglog.py +5 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/json.py +42 -7
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/list.py +49 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/misc.py +13 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/set.py +17 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/sorted_set.py +33 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/stream.py +33 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/string.py +29 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/pyproject.toml +1 -1
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_bitmap.py +24 -1
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_hash.py +47 -4
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_hyperloglog.py +17 -1
- awslabs_valkey_mcp_server-1.0.3/tests/test_json.py +365 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_json_additional.py +267 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_json_readonly.py +189 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_list_additional.py +100 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_list_readonly.py +173 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_main.py +1 -2
- awslabs_valkey_mcp_server-1.0.3/tests/test_misc.py +164 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_set_readonly.py +88 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_sorted_set_additional.py +322 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_sorted_set_readonly.py +131 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_stream_additional.py +159 -0
- awslabs_valkey_mcp_server-1.0.3/tests/test_stream_readonly.py +142 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_string.py +121 -6
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/uv.lock +1 -1
- awslabs_valkey_mcp_server-1.0.2/tests/test_json.py +0 -437
- awslabs_valkey_mcp_server-1.0.2/tests/test_sorted_set_additional.py +0 -221
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/.gitignore +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/.python-version +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/CHANGELOG.md +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/Dockerfile +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/ELASTICACHECONNECT.md +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/LICENSE +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/NOTICE +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/__init__.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/__init__.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/common/__init__.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/common/config.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/common/connection.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/common/server.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/__init__.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/tools/server_management.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/awslabs/valkey_mcp_server/version.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/docker-healthcheck.sh +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_config.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_connection.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_init.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_list.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_server_management.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_set.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_sorted_set.py +0 -0
- {awslabs_valkey_mcp_server-1.0.2 → awslabs_valkey_mcp_server-1.0.3}/tests/test_stream.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: awslabs.valkey-mcp-server
|
|
3
|
-
Version: 1.0.
|
|
3
|
+
Version: 1.0.3
|
|
4
4
|
Summary: An AWS Labs Model Context Protocol (MCP) server for valkey
|
|
5
5
|
Project-URL: homepage, https://awslabs.github.io/mcp/
|
|
6
6
|
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
|
|
|
50
50
|
- **Cluster Support**: Support for standalone and clustered Valkey deployments.
|
|
51
51
|
- **SSL/TLS Security**: Configure secure connections using SSL/TLS.
|
|
52
52
|
- **Connection Pooling**: Pools connections by default to enable efficient connection management.
|
|
53
|
+
- **Readonly Mode**: Prevent write operations to ensure data safety.
|
|
53
54
|
|
|
54
55
|
## Prerequisites
|
|
55
56
|
|
|
@@ -61,6 +62,8 @@ This MCP server provides tools to operate on Valkey data types. For example, it
|
|
|
61
62
|
|
|
62
63
|
## Installation
|
|
63
64
|
|
|
65
|
+
[](https://cursor.com/install-mcp?name=awslabs.valkey-mcp-server&config=eyJjb21tYW5kIjoidXZ4IGF3c2xhYnMudmFsa2V5LW1jcC1zZXJ2ZXJAbGF0ZXN0IiwiZW52Ijp7IlZBTEtFWV9IT1NUIjoiMTI3LjAuMC4xIiwiVkFMS0VZX1BPUlQiOiI2Mzc5IiwiRkFTVE1DUF9MT0dfTEVWRUwiOiJFUlJPUiJ9LCJhdXRvQXBwcm92ZSI6W10sImRpc2FibGVkIjpmYWxzZX0%3D)
|
|
66
|
+
|
|
64
67
|
Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q Developer CLI MCP, `~/.aws/amazonq/mcp.json`):
|
|
65
68
|
|
|
66
69
|
```json
|
|
@@ -83,6 +86,29 @@ Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q De
|
|
|
83
86
|
}
|
|
84
87
|
```
|
|
85
88
|
|
|
89
|
+
To run in readonly mode:
|
|
90
|
+
|
|
91
|
+
```json
|
|
92
|
+
{
|
|
93
|
+
"mcpServers": {
|
|
94
|
+
"awslabs.valkey-mcp-server": {
|
|
95
|
+
"command": "uvx",
|
|
96
|
+
"args": [
|
|
97
|
+
"awslabs.valkey-mcp-server@latest",
|
|
98
|
+
"--readonly"
|
|
99
|
+
],
|
|
100
|
+
"env": {
|
|
101
|
+
"VALKEY_HOST": "127.0.0.1",
|
|
102
|
+
"VALKEY_PORT": "6379",
|
|
103
|
+
"FASTMCP_LOG_LEVEL": "ERROR"
|
|
104
|
+
},
|
|
105
|
+
"autoApprove": [],
|
|
106
|
+
"disabled": false
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
86
112
|
Or using Docker after a successful `docker build -t awslabs/valkey-mcp-server .`:
|
|
87
113
|
|
|
88
114
|
```json
|
|
@@ -110,6 +136,34 @@ Or using Docker after a successful `docker build -t awslabs/valkey-mcp-server .`
|
|
|
110
136
|
}
|
|
111
137
|
```
|
|
112
138
|
|
|
139
|
+
To run in readonly mode with Docker:
|
|
140
|
+
|
|
141
|
+
```json
|
|
142
|
+
{
|
|
143
|
+
"mcpServers": {
|
|
144
|
+
"awslabs.valkey-mcp-server": {
|
|
145
|
+
"command": "docker",
|
|
146
|
+
"args": [
|
|
147
|
+
"run",
|
|
148
|
+
"--rm",
|
|
149
|
+
"--interactive",
|
|
150
|
+
"--env",
|
|
151
|
+
"FASTMCP_LOG_LEVEL=ERROR",
|
|
152
|
+
"--env",
|
|
153
|
+
"VALKEY_HOST=127.0.0.1",
|
|
154
|
+
"--env",
|
|
155
|
+
"VALKEY_PORT=6379",
|
|
156
|
+
"awslabs/valkey-mcp-server:latest",
|
|
157
|
+
"--readonly"
|
|
158
|
+
],
|
|
159
|
+
"env": {},
|
|
160
|
+
"disabled": false,
|
|
161
|
+
"autoApprove": []
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
113
167
|
## Configuration
|
|
114
168
|
|
|
115
169
|
The server can be configured using the following environment variables:
|
|
@@ -163,3 +217,11 @@ docker run -p 8080:8080 \
|
|
|
163
217
|
-e VALKEY_PORT=6379 \
|
|
164
218
|
awslabs/valkey-mcp-server
|
|
165
219
|
```
|
|
220
|
+
|
|
221
|
+
To run in readonly mode:
|
|
222
|
+
```bash
|
|
223
|
+
docker run -p 8080:8080 \
|
|
224
|
+
-e VALKEY_HOST=host.docker.internal \
|
|
225
|
+
-e VALKEY_PORT=6379 \
|
|
226
|
+
awslabs/valkey-mcp-server --readonly
|
|
227
|
+
```
|
|
@@ -19,6 +19,7 @@ This MCP server provides tools to operate on Valkey data types. For example, it
|
|
|
19
19
|
- **Cluster Support**: Support for standalone and clustered Valkey deployments.
|
|
20
20
|
- **SSL/TLS Security**: Configure secure connections using SSL/TLS.
|
|
21
21
|
- **Connection Pooling**: Pools connections by default to enable efficient connection management.
|
|
22
|
+
- **Readonly Mode**: Prevent write operations to ensure data safety.
|
|
22
23
|
|
|
23
24
|
## Prerequisites
|
|
24
25
|
|
|
@@ -30,6 +31,8 @@ This MCP server provides tools to operate on Valkey data types. For example, it
|
|
|
30
31
|
|
|
31
32
|
## Installation
|
|
32
33
|
|
|
34
|
+
[](https://cursor.com/install-mcp?name=awslabs.valkey-mcp-server&config=eyJjb21tYW5kIjoidXZ4IGF3c2xhYnMudmFsa2V5LW1jcC1zZXJ2ZXJAbGF0ZXN0IiwiZW52Ijp7IlZBTEtFWV9IT1NUIjoiMTI3LjAuMC4xIiwiVkFMS0VZX1BPUlQiOiI2Mzc5IiwiRkFTVE1DUF9MT0dfTEVWRUwiOiJFUlJPUiJ9LCJhdXRvQXBwcm92ZSI6W10sImRpc2FibGVkIjpmYWxzZX0%3D)
|
|
35
|
+
|
|
33
36
|
Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q Developer CLI MCP, `~/.aws/amazonq/mcp.json`):
|
|
34
37
|
|
|
35
38
|
```json
|
|
@@ -52,6 +55,29 @@ Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q De
|
|
|
52
55
|
}
|
|
53
56
|
```
|
|
54
57
|
|
|
58
|
+
To run in readonly mode:
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"mcpServers": {
|
|
63
|
+
"awslabs.valkey-mcp-server": {
|
|
64
|
+
"command": "uvx",
|
|
65
|
+
"args": [
|
|
66
|
+
"awslabs.valkey-mcp-server@latest",
|
|
67
|
+
"--readonly"
|
|
68
|
+
],
|
|
69
|
+
"env": {
|
|
70
|
+
"VALKEY_HOST": "127.0.0.1",
|
|
71
|
+
"VALKEY_PORT": "6379",
|
|
72
|
+
"FASTMCP_LOG_LEVEL": "ERROR"
|
|
73
|
+
},
|
|
74
|
+
"autoApprove": [],
|
|
75
|
+
"disabled": false
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
55
81
|
Or using Docker after a successful `docker build -t awslabs/valkey-mcp-server .`:
|
|
56
82
|
|
|
57
83
|
```json
|
|
@@ -79,6 +105,34 @@ Or using Docker after a successful `docker build -t awslabs/valkey-mcp-server .`
|
|
|
79
105
|
}
|
|
80
106
|
```
|
|
81
107
|
|
|
108
|
+
To run in readonly mode with Docker:
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"mcpServers": {
|
|
113
|
+
"awslabs.valkey-mcp-server": {
|
|
114
|
+
"command": "docker",
|
|
115
|
+
"args": [
|
|
116
|
+
"run",
|
|
117
|
+
"--rm",
|
|
118
|
+
"--interactive",
|
|
119
|
+
"--env",
|
|
120
|
+
"FASTMCP_LOG_LEVEL=ERROR",
|
|
121
|
+
"--env",
|
|
122
|
+
"VALKEY_HOST=127.0.0.1",
|
|
123
|
+
"--env",
|
|
124
|
+
"VALKEY_PORT=6379",
|
|
125
|
+
"awslabs/valkey-mcp-server:latest",
|
|
126
|
+
"--readonly"
|
|
127
|
+
],
|
|
128
|
+
"env": {},
|
|
129
|
+
"disabled": false,
|
|
130
|
+
"autoApprove": []
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
82
136
|
## Configuration
|
|
83
137
|
|
|
84
138
|
The server can be configured using the following environment variables:
|
|
@@ -132,3 +186,11 @@ docker run -p 8080:8080 \
|
|
|
132
186
|
-e VALKEY_PORT=6379 \
|
|
133
187
|
awslabs/valkey-mcp-server
|
|
134
188
|
```
|
|
189
|
+
|
|
190
|
+
To run in readonly mode:
|
|
191
|
+
```bash
|
|
192
|
+
docker run -p 8080:8080 \
|
|
193
|
+
-e VALKEY_HOST=host.docker.internal \
|
|
194
|
+
-e VALKEY_PORT=6379 \
|
|
195
|
+
awslabs/valkey-mcp-server --readonly
|
|
196
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""Context management for Valkey MCP Server."""
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class Context:
|
|
19
|
+
"""Context class for Valkey MCP Server."""
|
|
20
|
+
|
|
21
|
+
_readonly = False
|
|
22
|
+
|
|
23
|
+
@classmethod
|
|
24
|
+
def initialize(cls, readonly: bool = False):
|
|
25
|
+
"""Initialize the context.
|
|
26
|
+
|
|
27
|
+
Args:
|
|
28
|
+
readonly: Whether to run in readonly mode
|
|
29
|
+
"""
|
|
30
|
+
cls._readonly = readonly
|
|
31
|
+
|
|
32
|
+
@classmethod
|
|
33
|
+
def readonly_mode(cls) -> bool:
|
|
34
|
+
"""Check if the server is running in readonly mode.
|
|
35
|
+
|
|
36
|
+
Returns:
|
|
37
|
+
True if readonly mode is enabled, False otherwise
|
|
38
|
+
"""
|
|
39
|
+
return cls._readonly
|
|
@@ -14,7 +14,9 @@
|
|
|
14
14
|
|
|
15
15
|
"""awslabs valkey MCP Server implementation."""
|
|
16
16
|
|
|
17
|
+
import argparse
|
|
17
18
|
from awslabs.valkey_mcp_server.common.server import mcp
|
|
19
|
+
from awslabs.valkey_mcp_server.context import Context
|
|
18
20
|
from awslabs.valkey_mcp_server.tools import (
|
|
19
21
|
bitmap, # noqa: F401
|
|
20
22
|
hash, # noqa: F401
|
|
@@ -56,6 +58,18 @@ class ValkeyMCPServer:
|
|
|
56
58
|
|
|
57
59
|
def main():
|
|
58
60
|
"""Run the MCP server with CLI argument support."""
|
|
61
|
+
parser = argparse.ArgumentParser(
|
|
62
|
+
description='An AWS Labs Model Context Protocol (MCP) server for interacting with Valkey'
|
|
63
|
+
)
|
|
64
|
+
parser.add_argument(
|
|
65
|
+
'--readonly',
|
|
66
|
+
action=argparse.BooleanOptionalAction,
|
|
67
|
+
help='Prevents the MCP server from performing mutating operations',
|
|
68
|
+
)
|
|
69
|
+
|
|
70
|
+
args = parser.parse_args()
|
|
71
|
+
Context.initialize(args.readonly)
|
|
72
|
+
|
|
59
73
|
logger.info('Amazon ElastiCache/MemoryDB Valkey MCP Server Started...')
|
|
60
74
|
|
|
61
75
|
server = ValkeyMCPServer()
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
|
|
18
18
|
from awslabs.valkey_mcp_server.common.server import mcp
|
|
19
|
+
from awslabs.valkey_mcp_server.context import Context
|
|
19
20
|
from typing import Optional
|
|
20
21
|
from valkey.exceptions import ValkeyError
|
|
21
22
|
|
|
@@ -32,6 +33,10 @@ async def bitmap_set(key: str, offset: int, value: int) -> str:
|
|
|
32
33
|
Returns:
|
|
33
34
|
Success message or error message
|
|
34
35
|
"""
|
|
36
|
+
# Check if readonly mode is enabled
|
|
37
|
+
if Context.readonly_mode():
|
|
38
|
+
return 'Error: Cannot set bitmap bit in readonly mode'
|
|
39
|
+
|
|
35
40
|
try:
|
|
36
41
|
if value not in (0, 1):
|
|
37
42
|
return f'Error: value must be 0 or 1, got {value}'
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
|
|
18
18
|
from awslabs.valkey_mcp_server.common.server import mcp
|
|
19
|
+
from awslabs.valkey_mcp_server.context import Context
|
|
19
20
|
from typing import Any, Dict, Optional, Union
|
|
20
21
|
from valkey.exceptions import ValkeyError
|
|
21
22
|
|
|
@@ -32,6 +33,10 @@ async def hash_set(key: str, field: str, value: Any) -> str:
|
|
|
32
33
|
Returns:
|
|
33
34
|
Success message or error message
|
|
34
35
|
"""
|
|
36
|
+
# Check if readonly mode is enabled
|
|
37
|
+
if Context.readonly_mode():
|
|
38
|
+
return 'Error: Cannot set hash field in readonly mode'
|
|
39
|
+
|
|
35
40
|
try:
|
|
36
41
|
r = ValkeyConnectionManager.get_connection()
|
|
37
42
|
r.hset(key, field, value)
|
|
@@ -51,6 +56,10 @@ async def hash_set_multiple(key: str, mapping: Dict[str, Any]) -> str:
|
|
|
51
56
|
Returns:
|
|
52
57
|
Success message or error message
|
|
53
58
|
"""
|
|
59
|
+
# Check if readonly mode is enabled
|
|
60
|
+
if Context.readonly_mode():
|
|
61
|
+
return 'Error: Cannot set multiple hash fields in readonly mode'
|
|
62
|
+
|
|
54
63
|
try:
|
|
55
64
|
r = ValkeyConnectionManager.get_connection()
|
|
56
65
|
result = r.hset(key, mapping=mapping)
|
|
@@ -71,6 +80,10 @@ async def hash_set_if_not_exists(key: str, field: str, value: Any) -> str:
|
|
|
71
80
|
Returns:
|
|
72
81
|
Success message or error message
|
|
73
82
|
"""
|
|
83
|
+
# Check if readonly mode is enabled
|
|
84
|
+
if Context.readonly_mode():
|
|
85
|
+
return 'Error: Cannot set hash field in readonly mode'
|
|
86
|
+
|
|
74
87
|
try:
|
|
75
88
|
r = ValkeyConnectionManager.get_connection()
|
|
76
89
|
result = r.hsetnx(key, field, value)
|
|
@@ -153,6 +166,10 @@ async def hash_increment(key: str, field: str, amount: Union[int, float] = 1) ->
|
|
|
153
166
|
Returns:
|
|
154
167
|
New value or error message
|
|
155
168
|
"""
|
|
169
|
+
# Check if readonly mode is enabled
|
|
170
|
+
if Context.readonly_mode():
|
|
171
|
+
return 'Error: Cannot increment hash field in readonly mode'
|
|
172
|
+
|
|
156
173
|
try:
|
|
157
174
|
r = ValkeyConnectionManager.get_connection()
|
|
158
175
|
if isinstance(amount, int):
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
|
|
18
18
|
from awslabs.valkey_mcp_server.common.server import mcp
|
|
19
|
+
from awslabs.valkey_mcp_server.context import Context
|
|
19
20
|
from valkey.exceptions import ValkeyError
|
|
20
21
|
|
|
21
22
|
|
|
@@ -30,6 +31,10 @@ async def hll_add(key: str, element: str) -> str:
|
|
|
30
31
|
Returns:
|
|
31
32
|
Success message or error message
|
|
32
33
|
"""
|
|
34
|
+
# Check if readonly mode is enabled
|
|
35
|
+
if Context.readonly_mode():
|
|
36
|
+
return 'Error: Cannot add to HyperLogLog in readonly mode'
|
|
37
|
+
|
|
33
38
|
try:
|
|
34
39
|
if not element:
|
|
35
40
|
return 'Error: an element is required'
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
|
|
18
18
|
from awslabs.valkey_mcp_server.common.server import mcp
|
|
19
|
+
from awslabs.valkey_mcp_server.context import Context
|
|
19
20
|
from typing import Any, Optional, Union
|
|
20
21
|
from valkey.exceptions import ValkeyError
|
|
21
22
|
|
|
@@ -34,15 +35,13 @@ async def json_set(key: str, path: str, value: Any, nx: bool = False, xx: bool =
|
|
|
34
35
|
Returns:
|
|
35
36
|
Success message or error message
|
|
36
37
|
"""
|
|
38
|
+
# Check if readonly mode is enabled
|
|
39
|
+
if Context.readonly_mode():
|
|
40
|
+
return 'Error: Cannot set JSON value in readonly mode'
|
|
41
|
+
|
|
37
42
|
try:
|
|
38
43
|
r = ValkeyConnectionManager.get_connection()
|
|
39
|
-
|
|
40
|
-
if nx:
|
|
41
|
-
options['nx'] = True
|
|
42
|
-
if xx:
|
|
43
|
-
options['xx'] = True
|
|
44
|
-
|
|
45
|
-
result = r.json().set(key, path, value, **options)
|
|
44
|
+
result = r.json().set(key, path, value, nx=nx, xx=xx)
|
|
46
45
|
if result:
|
|
47
46
|
return f"Successfully set value at path '{path}' in '{key}'"
|
|
48
47
|
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:
|
|
|
121
120
|
Returns:
|
|
122
121
|
New value or error message
|
|
123
122
|
"""
|
|
123
|
+
# Check if readonly mode is enabled
|
|
124
|
+
if Context.readonly_mode():
|
|
125
|
+
return 'Error: Cannot increment JSON value in readonly mode'
|
|
126
|
+
|
|
124
127
|
try:
|
|
125
128
|
r = ValkeyConnectionManager.get_connection()
|
|
126
129
|
# 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:
|
|
|
143
146
|
Returns:
|
|
144
147
|
New value or error message
|
|
145
148
|
"""
|
|
149
|
+
# Check if readonly mode is enabled
|
|
150
|
+
if Context.readonly_mode():
|
|
151
|
+
return 'Error: Cannot multiply JSON value in readonly mode'
|
|
152
|
+
|
|
146
153
|
try:
|
|
147
154
|
r = ValkeyConnectionManager.get_connection()
|
|
148
155
|
# Convert float to int by rounding if needed
|
|
@@ -165,6 +172,10 @@ async def json_strappend(key: str, path: str, value: str) -> str:
|
|
|
165
172
|
Returns:
|
|
166
173
|
New string length or error message
|
|
167
174
|
"""
|
|
175
|
+
# Check if readonly mode is enabled
|
|
176
|
+
if Context.readonly_mode():
|
|
177
|
+
return 'Error: Cannot append to JSON string in readonly mode'
|
|
178
|
+
|
|
168
179
|
try:
|
|
169
180
|
r = ValkeyConnectionManager.get_connection()
|
|
170
181
|
result = r.json().strappend(key, path, value)
|
|
@@ -206,6 +217,10 @@ async def json_arrappend(key: str, path: str, *values: Any) -> str:
|
|
|
206
217
|
Returns:
|
|
207
218
|
New array length or error message
|
|
208
219
|
"""
|
|
220
|
+
# Check if readonly mode is enabled
|
|
221
|
+
if Context.readonly_mode():
|
|
222
|
+
return 'Error: Cannot append to JSON array in readonly mode'
|
|
223
|
+
|
|
209
224
|
try:
|
|
210
225
|
if not values:
|
|
211
226
|
return 'Error: at least one value is required'
|
|
@@ -285,6 +300,10 @@ async def json_arrpop(key: str, path: str, index: int = -1) -> str:
|
|
|
285
300
|
Returns:
|
|
286
301
|
Popped value or error message
|
|
287
302
|
"""
|
|
303
|
+
# Check if readonly mode is enabled
|
|
304
|
+
if Context.readonly_mode():
|
|
305
|
+
return 'Error: Cannot pop from JSON array in readonly mode'
|
|
306
|
+
|
|
288
307
|
try:
|
|
289
308
|
r = ValkeyConnectionManager.get_connection()
|
|
290
309
|
result = r.json().arrpop(key, path, index)
|
|
@@ -308,6 +327,10 @@ async def json_arrtrim(key: str, path: str, start: int, stop: int) -> str:
|
|
|
308
327
|
Returns:
|
|
309
328
|
New array length or error message
|
|
310
329
|
"""
|
|
330
|
+
# Check if readonly mode is enabled
|
|
331
|
+
if Context.readonly_mode():
|
|
332
|
+
return 'Error: Cannot trim JSON array in readonly mode'
|
|
333
|
+
|
|
311
334
|
try:
|
|
312
335
|
r = ValkeyConnectionManager.get_connection()
|
|
313
336
|
result = r.json().arrtrim(key, path, start, stop)
|
|
@@ -373,6 +396,10 @@ async def json_toggle(key: str, path: str) -> str:
|
|
|
373
396
|
Returns:
|
|
374
397
|
New boolean value or error message
|
|
375
398
|
"""
|
|
399
|
+
# Check if readonly mode is enabled
|
|
400
|
+
if Context.readonly_mode():
|
|
401
|
+
return 'Error: Cannot toggle JSON boolean in readonly mode'
|
|
402
|
+
|
|
376
403
|
try:
|
|
377
404
|
r = ValkeyConnectionManager.get_connection()
|
|
378
405
|
result = r.json().toggle(key, path)
|
|
@@ -394,6 +421,10 @@ async def json_clear(key: str, path: str) -> str:
|
|
|
394
421
|
Returns:
|
|
395
422
|
Success message or error message
|
|
396
423
|
"""
|
|
424
|
+
# Check if readonly mode is enabled
|
|
425
|
+
if Context.readonly_mode():
|
|
426
|
+
return 'Error: Cannot clear JSON container in readonly mode'
|
|
427
|
+
|
|
397
428
|
try:
|
|
398
429
|
r = ValkeyConnectionManager.get_connection()
|
|
399
430
|
result = r.json().clear(key, path)
|
|
@@ -415,6 +446,10 @@ async def json_del(key: str, path: str) -> str:
|
|
|
415
446
|
Returns:
|
|
416
447
|
Success message or error message
|
|
417
448
|
"""
|
|
449
|
+
# Check if readonly mode is enabled
|
|
450
|
+
if Context.readonly_mode():
|
|
451
|
+
return 'Error: Cannot delete JSON value in readonly mode'
|
|
452
|
+
|
|
418
453
|
try:
|
|
419
454
|
r = ValkeyConnectionManager.get_connection()
|
|
420
455
|
result = r.json().delete(key, path)
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
|
|
18
18
|
from awslabs.valkey_mcp_server.common.server import mcp
|
|
19
|
+
from awslabs.valkey_mcp_server.context import Context
|
|
19
20
|
from typing import Any, Optional
|
|
20
21
|
from typing import List as PyList
|
|
21
22
|
from valkey.exceptions import ValkeyError
|
|
@@ -32,6 +33,10 @@ async def list_append(key: str, value: Any) -> str:
|
|
|
32
33
|
Returns:
|
|
33
34
|
Success message or error message
|
|
34
35
|
"""
|
|
36
|
+
# Check if readonly mode is enabled
|
|
37
|
+
if Context.readonly_mode():
|
|
38
|
+
return 'Error: Cannot append to list in readonly mode'
|
|
39
|
+
|
|
35
40
|
try:
|
|
36
41
|
r = ValkeyConnectionManager.get_connection()
|
|
37
42
|
result = r.rpush(key, value)
|
|
@@ -51,6 +56,10 @@ async def list_prepend(key: str, value: Any) -> str:
|
|
|
51
56
|
Returns:
|
|
52
57
|
Success message or error message
|
|
53
58
|
"""
|
|
59
|
+
# Check if readonly mode is enabled
|
|
60
|
+
if Context.readonly_mode():
|
|
61
|
+
return 'Error: Cannot prepend to list in readonly mode'
|
|
62
|
+
|
|
54
63
|
try:
|
|
55
64
|
r = ValkeyConnectionManager.get_connection()
|
|
56
65
|
result = r.lpush(key, value)
|
|
@@ -70,6 +79,10 @@ async def list_append_multiple(key: str, values: PyList[Any]) -> str:
|
|
|
70
79
|
Returns:
|
|
71
80
|
Success message or error message
|
|
72
81
|
"""
|
|
82
|
+
# Check if readonly mode is enabled
|
|
83
|
+
if Context.readonly_mode():
|
|
84
|
+
return 'Error: Cannot append to list in readonly mode'
|
|
85
|
+
|
|
73
86
|
try:
|
|
74
87
|
r = ValkeyConnectionManager.get_connection()
|
|
75
88
|
result = r.rpush(key, *values)
|
|
@@ -89,6 +102,10 @@ async def list_prepend_multiple(key: str, values: PyList[Any]) -> str:
|
|
|
89
102
|
Returns:
|
|
90
103
|
Success message or error message
|
|
91
104
|
"""
|
|
105
|
+
# Check if readonly mode is enabled
|
|
106
|
+
if Context.readonly_mode():
|
|
107
|
+
return 'Error: Cannot prepend to list in readonly mode'
|
|
108
|
+
|
|
92
109
|
try:
|
|
93
110
|
r = ValkeyConnectionManager.get_connection()
|
|
94
111
|
result = r.lpush(key, *values)
|
|
@@ -130,6 +147,10 @@ async def list_set(key: str, index: int, value: Any) -> str:
|
|
|
130
147
|
Returns:
|
|
131
148
|
Success message or error message
|
|
132
149
|
"""
|
|
150
|
+
# Check if readonly mode is enabled
|
|
151
|
+
if Context.readonly_mode():
|
|
152
|
+
return 'Error: Cannot set list value in readonly mode'
|
|
153
|
+
|
|
133
154
|
try:
|
|
134
155
|
r = ValkeyConnectionManager.get_connection()
|
|
135
156
|
r.lset(key, index, value)
|
|
@@ -172,6 +193,10 @@ async def list_trim(key: str, start: int, stop: int) -> str:
|
|
|
172
193
|
Returns:
|
|
173
194
|
Success message or error message
|
|
174
195
|
"""
|
|
196
|
+
# Check if readonly mode is enabled
|
|
197
|
+
if Context.readonly_mode():
|
|
198
|
+
return 'Error: Cannot trim list in readonly mode'
|
|
199
|
+
|
|
175
200
|
try:
|
|
176
201
|
r = ValkeyConnectionManager.get_connection()
|
|
177
202
|
r.ltrim(key, start, stop)
|
|
@@ -209,6 +234,10 @@ async def list_pop_left(key: str, count: Optional[int] = None) -> str:
|
|
|
209
234
|
Returns:
|
|
210
235
|
Value(s) or error message
|
|
211
236
|
"""
|
|
237
|
+
# Check if readonly mode is enabled
|
|
238
|
+
if Context.readonly_mode():
|
|
239
|
+
return 'Error: Cannot pop from list in readonly mode'
|
|
240
|
+
|
|
212
241
|
try:
|
|
213
242
|
r = ValkeyConnectionManager.get_connection()
|
|
214
243
|
if count:
|
|
@@ -233,6 +262,10 @@ async def list_pop_right(key: str, count: Optional[int] = None) -> str:
|
|
|
233
262
|
Returns:
|
|
234
263
|
Value(s) or error message
|
|
235
264
|
"""
|
|
265
|
+
# Check if readonly mode is enabled
|
|
266
|
+
if Context.readonly_mode():
|
|
267
|
+
return 'Error: Cannot pop from list in readonly mode'
|
|
268
|
+
|
|
236
269
|
try:
|
|
237
270
|
r = ValkeyConnectionManager.get_connection()
|
|
238
271
|
if count:
|
|
@@ -299,6 +332,10 @@ async def list_move(
|
|
|
299
332
|
Returns:
|
|
300
333
|
Moved value or error message
|
|
301
334
|
"""
|
|
335
|
+
# Check if readonly mode is enabled
|
|
336
|
+
if Context.readonly_mode():
|
|
337
|
+
return 'Error: Cannot move list elements in readonly mode'
|
|
338
|
+
|
|
302
339
|
try:
|
|
303
340
|
r = ValkeyConnectionManager.get_connection()
|
|
304
341
|
wherefrom = wherefrom.upper()
|
|
@@ -327,6 +364,10 @@ async def list_insert_before(key: str, pivot: Any, value: Any) -> str:
|
|
|
327
364
|
Returns:
|
|
328
365
|
Success message or error message
|
|
329
366
|
"""
|
|
367
|
+
# Check if readonly mode is enabled
|
|
368
|
+
if Context.readonly_mode():
|
|
369
|
+
return 'Error: Cannot insert into list in readonly mode'
|
|
370
|
+
|
|
330
371
|
try:
|
|
331
372
|
r = ValkeyConnectionManager.get_connection()
|
|
332
373
|
result = r.linsert(key, 'BEFORE', pivot, value)
|
|
@@ -349,6 +390,10 @@ async def list_insert_after(key: str, pivot: Any, value: Any) -> str:
|
|
|
349
390
|
Returns:
|
|
350
391
|
Success message or error message
|
|
351
392
|
"""
|
|
393
|
+
# Check if readonly mode is enabled
|
|
394
|
+
if Context.readonly_mode():
|
|
395
|
+
return 'Error: Cannot insert into list in readonly mode'
|
|
396
|
+
|
|
352
397
|
try:
|
|
353
398
|
r = ValkeyConnectionManager.get_connection()
|
|
354
399
|
result = r.linsert(key, 'AFTER', pivot, value)
|
|
@@ -371,6 +416,10 @@ async def list_remove(key: str, value: Any, count: int = 0) -> str:
|
|
|
371
416
|
Returns:
|
|
372
417
|
Success message or error message
|
|
373
418
|
"""
|
|
419
|
+
# Check if readonly mode is enabled
|
|
420
|
+
if Context.readonly_mode():
|
|
421
|
+
return 'Error: Cannot remove from list in readonly mode'
|
|
422
|
+
|
|
374
423
|
try:
|
|
375
424
|
r = ValkeyConnectionManager.get_connection()
|
|
376
425
|
result = r.lrem(key, count, value)
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
from awslabs.valkey_mcp_server.common.connection import ValkeyConnectionManager
|
|
16
16
|
from awslabs.valkey_mcp_server.common.server import mcp
|
|
17
|
+
from awslabs.valkey_mcp_server.context import Context
|
|
17
18
|
from typing import Any, Dict
|
|
18
19
|
from valkey.exceptions import ValkeyError as RedisError
|
|
19
20
|
|
|
@@ -28,6 +29,10 @@ async def delete(key: str) -> str:
|
|
|
28
29
|
Returns:
|
|
29
30
|
str: Confirmation message or an error message.
|
|
30
31
|
"""
|
|
32
|
+
# Check if readonly mode is enabled
|
|
33
|
+
if Context.readonly_mode():
|
|
34
|
+
return 'Error: Cannot delete key in readonly mode'
|
|
35
|
+
|
|
31
36
|
try:
|
|
32
37
|
r = ValkeyConnectionManager.get_connection()
|
|
33
38
|
result = r.delete(key)
|
|
@@ -67,6 +72,10 @@ async def expire(name: str, expire_seconds: int) -> str:
|
|
|
67
72
|
Returns:
|
|
68
73
|
A success message or an error message.
|
|
69
74
|
"""
|
|
75
|
+
# Check if readonly mode is enabled
|
|
76
|
+
if Context.readonly_mode():
|
|
77
|
+
return 'Error: Cannot set expiration in readonly mode'
|
|
78
|
+
|
|
70
79
|
try:
|
|
71
80
|
r = ValkeyConnectionManager.get_connection()
|
|
72
81
|
success = r.expire(name, expire_seconds)
|
|
@@ -92,6 +101,10 @@ async def rename(old_key: str, new_key: str) -> Dict[str, Any]:
|
|
|
92
101
|
On success: {"status": "success", "message": "..."}
|
|
93
102
|
On error: {"error": "..."}
|
|
94
103
|
"""
|
|
104
|
+
# Check if readonly mode is enabled
|
|
105
|
+
if Context.readonly_mode():
|
|
106
|
+
return {'error': 'Cannot rename key in readonly mode'}
|
|
107
|
+
|
|
95
108
|
try:
|
|
96
109
|
r = ValkeyConnectionManager.get_connection()
|
|
97
110
|
|