awslabs.valkey-mcp-server 0.1.1__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.
Files changed (48) hide show
  1. awslabs_valkey_mcp_server-0.1.1/.gitignore +59 -0
  2. awslabs_valkey_mcp_server-0.1.1/.pre-commit-config.yaml +14 -0
  3. awslabs_valkey_mcp_server-0.1.1/.python-version +1 -0
  4. awslabs_valkey_mcp_server-0.1.1/CHANGELOG.md +12 -0
  5. awslabs_valkey_mcp_server-0.1.1/Dockerfile +75 -0
  6. awslabs_valkey_mcp_server-0.1.1/ELASTICACHECONNECT.md +87 -0
  7. awslabs_valkey_mcp_server-0.1.1/LICENSE +175 -0
  8. awslabs_valkey_mcp_server-0.1.1/NOTICE +2 -0
  9. awslabs_valkey_mcp_server-0.1.1/PKG-INFO +164 -0
  10. awslabs_valkey_mcp_server-0.1.1/README.md +133 -0
  11. awslabs_valkey_mcp_server-0.1.1/awslabs/__init__.py +13 -0
  12. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/__init__.py +14 -0
  13. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/common/__init__.py +20 -0
  14. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/common/config.py +85 -0
  15. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/common/connection.py +97 -0
  16. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/common/server.py +23 -0
  17. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/main.py +84 -0
  18. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/__init__.py +28 -0
  19. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/bitmap.py +148 -0
  20. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/hash.py +283 -0
  21. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/hyperloglog.py +58 -0
  22. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/json.py +422 -0
  23. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/list.py +376 -0
  24. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/misc.py +104 -0
  25. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/server_management.py +54 -0
  26. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/set.py +182 -0
  27. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/sorted_set.py +359 -0
  28. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/stream.py +343 -0
  29. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/tools/string.py +228 -0
  30. awslabs_valkey_mcp_server-0.1.1/awslabs/valkey_mcp_server/version.py +12 -0
  31. awslabs_valkey_mcp_server-0.1.1/docker-healthcheck.sh +16 -0
  32. awslabs_valkey_mcp_server-0.1.1/pyproject.toml +138 -0
  33. awslabs_valkey_mcp_server-0.1.1/tests/test_bitmap.py +146 -0
  34. awslabs_valkey_mcp_server-0.1.1/tests/test_config.py +222 -0
  35. awslabs_valkey_mcp_server-0.1.1/tests/test_connection.py +307 -0
  36. awslabs_valkey_mcp_server-0.1.1/tests/test_hash.py +325 -0
  37. awslabs_valkey_mcp_server-0.1.1/tests/test_hyperloglog.py +78 -0
  38. awslabs_valkey_mcp_server-0.1.1/tests/test_init.py +49 -0
  39. awslabs_valkey_mcp_server-0.1.1/tests/test_json.py +434 -0
  40. awslabs_valkey_mcp_server-0.1.1/tests/test_list.py +373 -0
  41. awslabs_valkey_mcp_server-0.1.1/tests/test_main.py +67 -0
  42. awslabs_valkey_mcp_server-0.1.1/tests/test_server_management.py +104 -0
  43. awslabs_valkey_mcp_server-0.1.1/tests/test_set.py +204 -0
  44. awslabs_valkey_mcp_server-0.1.1/tests/test_sorted_set.py +170 -0
  45. awslabs_valkey_mcp_server-0.1.1/tests/test_sorted_set_additional.py +218 -0
  46. awslabs_valkey_mcp_server-0.1.1/tests/test_stream.py +257 -0
  47. awslabs_valkey_mcp_server-0.1.1/tests/test_string.py +180 -0
  48. awslabs_valkey_mcp_server-0.1.1/uv.lock +1154 -0
@@ -0,0 +1,59 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ *.so
6
+ .Python
7
+ build/
8
+ develop-eggs/
9
+ dist/
10
+ downloads/
11
+ eggs/
12
+ .eggs/
13
+ lib/
14
+ lib64/
15
+ parts/
16
+ sdist/
17
+ var/
18
+ wheels/
19
+ share/python-wheels/
20
+ *.egg-info/
21
+ .installed.cfg
22
+ *.egg
23
+ MANIFEST
24
+
25
+ # Virtual environments
26
+ .venv
27
+ env/
28
+ venv/
29
+ ENV/
30
+
31
+ # IDE
32
+ .idea/
33
+ .vscode/
34
+ *.swp
35
+ *.swo
36
+
37
+ # Testing
38
+ .tox/
39
+ .coverage
40
+ .coverage.*
41
+ htmlcov/
42
+ .pytest_cache/
43
+
44
+ # Ruff
45
+ .ruff_cache/
46
+
47
+ # Build
48
+ *.manifest
49
+ *.spec
50
+ .pybuilder/
51
+ target/
52
+
53
+ # Environments
54
+ .env
55
+ .env.local
56
+ .env.*.local
57
+
58
+ # PyPI
59
+ .pypirc
@@ -0,0 +1,14 @@
1
+ repos:
2
+ - repo: https://github.com/astral-sh/ruff-pre-commit
3
+ rev: v0.9.6
4
+ hooks:
5
+ - id: ruff
6
+ args: [--fix]
7
+ - id: ruff-format
8
+
9
+ - repo: https://github.com/commitizen-tools/commitizen
10
+ rev: v3.13.0
11
+ hooks:
12
+ - id: commitizen
13
+ - id: commitizen-branch
14
+ stages: [push]
@@ -0,0 +1 @@
1
+ 3.10
@@ -0,0 +1,12 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## Unreleased
9
+
10
+ ### Added
11
+
12
+ - Initial project setup
@@ -0,0 +1,75 @@
1
+ # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
4
+ # with the License. A copy of the License is located at
5
+ #
6
+ # http://www.apache.org/licenses/LICENSE-2.0
7
+ #
8
+ # or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
9
+ # OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
10
+ # and limitations under the License.
11
+
12
+ #FROM public.ecr.aws/sam/build-python3.10:1.137.1-20250411084548
13
+ FROM public.ecr.aws/sam/build-python3.10@sha256:04cdbe84bec08d17d621192bc3f0a9e4a85a83f2ac99aa9241659dfac0d845ea AS uv
14
+
15
+ # Install the project into `/app`
16
+ WORKDIR /app
17
+
18
+ # Enable bytecode compilation
19
+ ENV UV_COMPILE_BYTECODE=1
20
+
21
+ # Copy from the cache instead of linking since it's a mounted volume
22
+ ENV UV_LINK_MODE=copy
23
+
24
+ # Prefer the system python
25
+ ENV UV_PYTHON_PREFERENCE=only-system
26
+
27
+ # Run without updating the uv.lock file like running with `--frozen`
28
+ ENV UV_FROZEN=true
29
+
30
+ # Copy the required files first
31
+ COPY pyproject.toml uv.lock ./
32
+
33
+ # Install the project's dependencies using the lockfile and settings
34
+ RUN --mount=type=cache,target=/root/.cache/uv \
35
+ pip install uv && \
36
+ uv sync --frozen --no-install-project --no-dev --no-editable
37
+
38
+ # Then, add the rest of the project source code and install it
39
+ # Installing separately from its dependencies allows optimal layer caching
40
+ COPY . /app
41
+ RUN --mount=type=cache,target=/root/.cache/uv \
42
+ uv sync --frozen --no-dev --no-editable
43
+
44
+ # Make the directory just in case it doesn't exist
45
+ RUN mkdir -p /root/.local
46
+
47
+ FROM public.ecr.aws/sam/build-python3.10@sha256:04cdbe84bec08d17d621192bc3f0a9e4a85a83f2ac99aa9241659dfac0d845ea
48
+
49
+ # Place executables in the environment at the front of the path and include other binaries
50
+ ENV PATH="/app/.venv/bin:$PATH:/usr/sbin"
51
+
52
+ # Install lsof for the healthcheck
53
+ # Install other tools as needed for the MCP server
54
+ # Add non-root user and ability to change directory into /root
55
+ RUN yum update -y && \
56
+ yum install -y lsof && \
57
+ yum clean all -y && \
58
+ rm -rf /var/cache/yum && \
59
+ groupadd --force --system app && \
60
+ useradd app -g app -d /app && \
61
+ chmod o+x /root
62
+
63
+ # Get the project from the uv layer
64
+ COPY --from=uv --chown=app:app /root/.local /root/.local
65
+ COPY --from=uv --chown=app:app /app/.venv /app/.venv
66
+
67
+ # Get healthcheck script
68
+ COPY ./docker-healthcheck.sh /usr/local/bin/docker-healthcheck.sh
69
+
70
+ # Run as non-root
71
+ USER app
72
+
73
+ # When running the container, add --valkey-host and --valkey-port to connect to Valkey server
74
+ HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 CMD [ "docker-healthcheck.sh" ]
75
+ ENTRYPOINT ["awslabs.valkey-mcp-server"]
@@ -0,0 +1,87 @@
1
+ # How to connect to an Amazon ElastiCache Valkey datastore
2
+
3
+ ## Launch and configure the EC2 instance
4
+
5
+ Complete the following steps:
6
+
7
+ 1. Open the Amazon EC2 console, and then choose Launch instance.
8
+ 2. Select an Amazon Machine Image (AMI).
9
+ 3. Choose an instance type, and then choose Next: Configure Instance Details.
10
+ 4. For Network, choose the VPC that the Amazon ElastiCache Valkey cache uses.
11
+ 5. For Subnet, select the private subnet in the VPC
12
+ 6. Choose Next: Add Storage, and then modify the storage as needed.
13
+ 7. Choose Next: Add Tags, and then add tags as needed.
14
+ 8. Choose Next: Configure Security Group.
15
+ 9. Choose Add Rule, and then enter the following:
16
+ * For Type, enter Custom TCP Rule
17
+ * For Protocol, enter TCP
18
+ * For Port Range, enter 22
19
+ * For Source, enter the security group used by your Amazon EC2 connect endpoint.
20
+ 10. Choose Review and Launch, and then choose Launch.
21
+
22
+ ## Configure the Amazon ElastiCache Cache’s security groups
23
+
24
+ Complete the following steps:
25
+
26
+ 1. Open the Amazon ElastiCache console.
27
+ 2. In the navigation pane, choose Resources → Valkey caches.
28
+ 3. Choose the name of the Amazon Valkey Cache. If you don't already have one, then create it.
29
+ 4. Under Actions, select the option “Setup compute connection - new”
30
+ 5. In the dropdown, select the EC2 instance you created above.
31
+ 6. Click Setup.
32
+
33
+ This configuration for the security group allows traffic from the EC2 instance's private IP address. If the EC2 instance and the Amazon ElastiCache Valkey cache use the same VPC, then you don't need to modify the Amazon ElastiCache Valkey cache route table. If the VPC is different, then create a VPC peering connection to allow connections between those VPCs.
34
+ Note: If you use a more scalable solution, then review your configuration. For example, if you use the security group ID in a security group rule, then make sure that it doesn't restrict access to one instance. Instead, configure the rule to restrict access to any resource that uses the specific security group ID.
35
+
36
+ ## Create an EC2 instance connect endpoint
37
+
38
+ 1. Open the Amazon VPC console.
39
+ 2. In the navigation pane, choose Endpoints.
40
+ 3. Choose Create endpoint, and then specify the endpoint settings.
41
+ * (Optional) For Name tag, enter a name for the endpoint.
42
+ * For Service category, choose EC2 Instance Connect Endpoint.
43
+ * For VPC, select the VPC that has the target instances.
44
+ * (Optional) To preserve client IP addresses, expand Additional settings and select the check box. Otherwise, the default is to use the endpoint network interface as the client IP address.
45
+ * For Security groups, select the security group you want to associate with the endpoint. Otherwise, the default is to use the default security group for the VPC.
46
+ * For Subnet, select the subnet in which to create the endpoint.
47
+ * (Optional) To add a tag, choose Add new tag and enter the tag key and the tag value.
48
+ 4. Review your settings and then choose Create endpoint.
49
+ 5. The initial status of the endpoint is Pending. To connect to an instance, you must wait until the endpoint status is Available. This can take up to a few minutes.
50
+
51
+ ## Connect to the ElastiCache Valkey cache from your local machine
52
+
53
+ **Note**: You must have access to the AWS CLI.
54
+
55
+ To connect from your local MCP Server to a private Amazon ElastiCache Valkey cache through an SSH tunnel, complete the following steps:
56
+ Linux or macOS
57
+ Run the following command to open a tunnel from local machine to the EC2 instance:
58
+
59
+ ```
60
+ aws ec2-instance-connect open-tunnel --instance-id ec2-instance-ID --local-port 6379
61
+ ```
62
+
63
+ **Note**: Replace ec2-instance-ID with your EC2 instance ID.
64
+
65
+ Open a second connection and run the following command to create an SSH tunnel from your local host to your ElastiCache Valkey Cache through an EC2 instance:
66
+
67
+ ```
68
+ ssh -i YOUR_EC2_KEY EC2_USER@EC2_HOST -p EC2_TUNNEL_PORT -L LOCAL_PORT:ELASTICACHE_ENDPOINT:REMOTE_PORT -N -f
69
+ ```
70
+
71
+ **Note**: Replace the following values:
72
+ * **YOUR_EC2_KEY** with the path to your EC2 private key file
73
+ * **EC2_USER** with your EC2 instance username
74
+ * **EC2_HOST** with the hostname of your EC2 instance
75
+ * **EC2_TUNNEL_PORT** with the port you configured
76
+ * **LOCAL_PORT** with an unused port on your local machine (6379)
77
+ * **ELASTICACHE_ENDPOINT** with the endpoint of your ElastiCache Valkey cache
78
+ * **REMOTE_PORT** with the port that your Amazon ElastiCache Valkey cache uses (6379)
79
+
80
+ Use a third connection and run the following command to verify connection to your Amazon ElastiCache Valkey cache from your local machine:
81
+
82
+ ```
83
+ valkey-cli -h 127.0.0.1 -p LOCAL_PORT
84
+ ```
85
+
86
+ **Note**: Replace the following values:
87
+ * **LOCAL_PORT** with the number of your local port (6379)
@@ -0,0 +1,175 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
@@ -0,0 +1,2 @@
1
+ awslabs.valkey-mcp-server
2
+ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -0,0 +1,164 @@
1
+ Metadata-Version: 2.4
2
+ Name: awslabs.valkey-mcp-server
3
+ Version: 0.1.1
4
+ Summary: An AWS Labs Model Context Protocol (MCP) server for valkey
5
+ Project-URL: homepage, https://awslabs.github.io/mcp/
6
+ Project-URL: docs, https://awslabs.github.io/mcp/servers/valkey-mcp-server/
7
+ Project-URL: documentation, https://awslabs.github.io/mcp/servers/valkey-mcp-server/
8
+ Project-URL: repository, https://github.com/awslabs/mcp.git
9
+ Project-URL: changelog, https://github.com/awslabs/mcp/blob/main/src/valkey-mcp-server/CHANGELOG.md
10
+ Author: Amazon Web Services
11
+ Author-email: AWSLabs MCP <203918161+awslabs-mcp@users.noreply.github.com>, seaofawareness <utkarshshah@gmail.com>
12
+ License: Apache-2.0
13
+ License-File: LICENSE
14
+ License-File: NOTICE
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Requires-Python: >=3.10
24
+ Requires-Dist: dotenv>=0.9.9
25
+ Requires-Dist: loguru>=0.7.0
26
+ Requires-Dist: mcp[cli]>=1.6.0
27
+ Requires-Dist: numpy>=2.2.4
28
+ Requires-Dist: pydantic>=2.10.6
29
+ Requires-Dist: valkey>=6.1.0
30
+ Description-Content-Type: text/markdown
31
+
32
+ # Amazon ElastiCache/MemoryDB Valkey MCP Server
33
+
34
+ An AWS Labs Model Context Protocol (MCP) server for Amazon ElastiCache [Valkey](https://valkey.io/) datastores.
35
+
36
+ ## Features
37
+ This MCP server provides tools to operate on Valkey data types. For example, it allows an agent to operate with Valkey Strings using commands such as SET, SETRANGE, GET, GETRANGE, APPEND, INCREMENT and more.
38
+
39
+ ### Supported Data Types
40
+ - `Strings`- Store, retrieve, append, increment, decrement, length and more.
41
+ - `Lists`- Manage List collections with push/pop operations.
42
+ - `Sets and Sorted Sets`- Store and retrieve items from Sets.
43
+ - `Hashes`- Store and retrieve items in Hashes. Check for existence of items in a hash, increment item values in a Hash, and more.
44
+ - `Streams`- Store, retrieve, trim items in Streams.
45
+ - `Bitmaps`- Bitmaps let you perform bitwise operations on strings.
46
+ - `JSONs`- Store and retrieve JSON documents with path-based access.
47
+ - `HyperLogLog`- Store and count items in HyperLogs.
48
+
49
+ ### Advanced Features
50
+ - **Cluster Support**: Support for standalone and clustered Valkey deployments.
51
+ - **SSL/TLS Security**: Configure secure connections using SSL/TLS.
52
+ - **Connection Pooling**: Pools connections by default to enable efficient connection management.
53
+
54
+ ## Prerequisites
55
+
56
+ 1. Install `uv` from [Astral](https://docs.astral.sh/uv/getting-started/installation/) or the [GitHub README](https://github.com/astral-sh/uv#installation)
57
+ 2. Install Python using `uv python install 3.10`
58
+ 3. Access to a Valkey datastore instance. For instructions to connect to an Amazon ElastiCache/MemoryDB Valkey cache [click here](ELASTICACHECONNECT.md).
59
+
60
+
61
+ ## Installation
62
+
63
+ Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q Developer CLI MCP, `~/.aws/amazonq/mcp.json`):
64
+
65
+ ```json
66
+ {
67
+ "mcpServers": {
68
+ "awslabs.valkey-mcp-server": {
69
+ "command": "uvx",
70
+ "args": [
71
+ "awslabs.valkey-mcp-server@latest"
72
+ ],
73
+ "env": {
74
+ "VALKEY_HOST": "127.0.0.1",
75
+ "VALKEY_PORT": "6379",
76
+ "FASTMCP_LOG_LEVEL": "ERROR"
77
+ },
78
+ "autoApprove": [],
79
+ "disabled": false
80
+ }
81
+ }
82
+ }
83
+ ```
84
+
85
+ Or using Docker after a successful `docker build -t awslabs/valkey-mcp-server .`:
86
+
87
+ ```json
88
+ {
89
+ "mcpServers": {
90
+ "awslabs.valkey-mcp-server": {
91
+ "command": "docker",
92
+ "args": [
93
+ "run",
94
+ "--rm",
95
+ "--interactive",
96
+ "--env",
97
+ "FASTMCP_LOG_LEVEL=ERROR",
98
+ "--env",
99
+ "VALKEY_HOST=127.0.0.1",
100
+ "--env",
101
+ "VALKEY_PORT=6379",
102
+ "awslabs/valkey-mcp-server:latest"
103
+ ],
104
+ "env": {},
105
+ "disabled": false,
106
+ "autoApprove": []
107
+ }
108
+ }
109
+ }
110
+ ```
111
+
112
+ ## Configuration
113
+
114
+ The server can be configured using the following environment variables:
115
+
116
+ | Name | Description | Default Value |
117
+ |------|-------------|---------------|
118
+ | `VALKEY_HOST` | ElastiCache Primary Endpoint or MemoryDB Cluster Endpoint or Valkey IP or hostname | `"127.0.0.1"` |
119
+ | `VALKEY_PORT` | Valkey port | `6379` |
120
+ | `VALKEY_USERNAME` | Default database username | `None` |
121
+ | `VALKEY_PWD` | Default database password | `""` |
122
+ | `VALKEY_USE_SSL` | Enables or disables SSL/TLS | `False` |
123
+ | `VALKEY_CA_PATH` | CA certificate for verifying server | `None` |
124
+ | `VALKEY_SSL_KEYFILE` | Client's private key file | `None` |
125
+ | `VALKEY_SSL_CERTFILE` | Client's certificate file | `None` |
126
+ | `VALKEY_CERT_REQS` | Server certificate verification | `"required"` |
127
+ | `VALKEY_CA_CERTS` | Path to trusted CA certificates | `None` |
128
+ | `VALKEY_CLUSTER_MODE` | Enable Valkey Cluster mode | `False` |
129
+
130
+ ## Example Usage
131
+
132
+ Here are some example natural language queries that the server can handle:
133
+
134
+ ```
135
+ "Store user profile data in a hash"
136
+ "Add this event to the activity stream"
137
+ "Cache API response for 5 minutes"
138
+ "Store JSON document with nested fields"
139
+ "Add score 100 to user123 in leaderboard"
140
+ "Get all members of the admins set"
141
+ ```
142
+
143
+ ## Development
144
+
145
+ ### Running Tests
146
+ ```bash
147
+ uv venv
148
+ source .venv/bin/activate
149
+ uv sync
150
+ uv run --frozen pytest
151
+ ```
152
+
153
+ ### Building Docker Image
154
+ ```bash
155
+ docker build -t awslabs/valkey-mcp-server .
156
+ ```
157
+
158
+ ### Running Docker Container
159
+ ```bash
160
+ docker run -p 8080:8080 \
161
+ -e VALKEY_HOST=host.docker.internal \
162
+ -e VALKEY_PORT=6379 \
163
+ awslabs/valkey-mcp-server
164
+ ```