awslabs.amazon-keyspaces-mcp-server 0.0.1__tar.gz

awslabs_amazon_keyspaces_mcp_server-0.0.1/.gitignore

@@ -0,0 +1,64 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Certificate files
+awslabs/certs/
+awslabs/certs/*
+!awslabs/certs/.gitkeep
+
+# Virtual environments
+.venv
+env/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.tox/
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+
+# Ruff
+.ruff_cache/
+
+# Build
+*.manifest
+*.spec
+.pybuilder/
+target/
+
+# Environments
+.env
+.env.local
+.env.*.local
+
+# PyPI
+.pypirc

awslabs_amazon_keyspaces_mcp_server-0.0.1/.python-version

@@ -0,0 +1 @@
+3.10

awslabs_amazon_keyspaces_mcp_server-0.0.1/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+- Initial project setup
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+- Initial project setup

awslabs_amazon_keyspaces_mcp_server-0.0.1/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

awslabs_amazon_keyspaces_mcp_server-0.0.1/NOTICE

@@ -0,0 +1,2 @@
+awslabs.amazon-keyspaces-mcp-server
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

awslabs_amazon_keyspaces_mcp_server-0.0.1/PKG-INFO

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: awslabs.amazon-keyspaces-mcp-server
+Version: 0.0.1
+Summary: An Amazon Keyspaces (for Apache Cassandra) MCP server for interacting with Amazon Keyspaces and Apache Cassandra.
+Project-URL: homepage, https://awslabs.github.io/mcp/
+Project-URL: docs, https://awslabs.github.io/mcp/servers/amazon-keyspaces-mcp-server/
+Project-URL: documentation, https://awslabs.github.io/mcp/servers/amazon-keyspaces-mcp-server/
+Project-URL: repository, https://github.com/awslabs/mcp.git
+Project-URL: changelog, https://github.com/awslabs/mcp/blob/main/src/amazon-keyspaces-mcp-server/CHANGELOG.md
+Author: Amazon Web Services
+Author-email: AWSLabs MCP <203918161+awslabs-mcp@users.noreply.github.com>, Joel Shepherd <shepherd@amazon.com>
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: <3.12,>=3.10
+Requires-Dist: boto3>=1.37.27
+Requires-Dist: cassandra-driver>=3.25.0
+Requires-Dist: fastmcp>=0.1.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: mcp>=0.9.1
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: python-dotenv>=1.0.0
+Description-Content-Type: text/markdown
+
+# AWS Labs amazon-keyspaces MCP Server
+
+An Amazon Keyspaces (for Apache Cassandra) MCP server for interacting with Amazon Keyspaces and Apache Cassandra.
+
+## Overview
+
+The Amazon Keyspaces MCP server implements the Model Context Protocol (MCP) to enable AI assistants like Amazon Q to
+interact with Amazon Keyspaces or Apache Cassandra databases through natural language. This server allows you to explore
+ database schemas, execute queries, and analyze query performance without having to write CQL code directly.
+
+## Features
+
+The Amazon Keyspaces (for Apache Cassandra) MCP server provides the following capabilities:
+1. **Schema**: Explore keyspaces and tables.
+2. **Run Queries**: Execute CQL SELECT queries against the configured database.
+3. **Query Analysis**: Get feedback and suggestions for improving query performance.
+4. **Cassandra-Compatible**: Use with Amazon Keyspaces, or with Apache Cassandra.
+
+Here are some example prompts that this MCP server can help with:
+- "List all keyspaces in my Cassandra database"
+- "Show me the tables in the 'sales' keyspace"
+- "Describe the 'users' table in the 'sales' keyspace"
+- "What's the schema of the 'products' table?"
+- "Run a SELECT query to get all users from the 'users' table in 'sales'"
+- "Query the first 10 records from the 'events' table"
+- "Analyze the performance of this query: SELECT * FROM users WHERE last_name = 'Smith'"
+- "Is this query efficient: SELECT * FROM orders WHERE order_date > '2023-01-01'?"
+
+## Installation
+
+### Prerequisites
+
+- Python 3.10 or 3.11 (Python 3.12+ is not fully supported due to asyncore module removal)
+- Access to an Amazon Keyspaces instance or Apache Cassandra cluster that supports password authentication
+- Appropriate Cassandra log-in credentials
+- Starfield digital certificate (required for Amazon Keyspaces)
+
+### Install from PyPI
+
+```bash
+pip install awslabs.amazon-keyspaces-mcp-server
+```
+
+### Install from Source
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/awslabs/mcp.git
+   cd mcp/src/amazon-keyspaces-mcp-server
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   ```
+
+3. Install the package:
+   ```bash
+   pip install -e .
+   ```
+
+## Configuration
+
+Create a `.env` file in your working directory with your database connection settings:
+
+```
+# Set to true for Amazon Keyspaces, false for Apache Cassandra
+DB_USE_KEYSPACES=true
+
+# Cassandra configuration (for native Cassandra)
+DB_CASSANDRA_CONTACT_POINTS=127.0.0.1
+DB_CASSANDRA_PORT=9042
+DB_CASSANDRA_LOCAL_DATACENTER=datacenter1
+DB_CASSANDRA_USERNAME=
+DB_CASSANDRA_PASSWORD=
+
+# Keyspaces configuration (for Amazon Keyspaces)
+DB_KEYSPACES_ENDPOINT=cassandra.us-west-2.amazonaws.com
+DB_KEYSPACES_REGION=us-west-2
+```
+
+### Authentication Credentials
+
+This MCP server uses username and password authentication for both Amazon Keyspaces and Apache Cassandra:
+
+- For **Amazon Keyspaces**: Set the `DB_CASSANDRA_USERNAME` and `DB_CASSANDRA_PASSWORD` environment variables with
+your Keyspaces username and password. These are the same service-specific credentials you would use to access Keyspaces
+via the Cassandra Query Language (CQL) shell.
+
+- For **Apache Cassandra**: Set the `DB_CASSANDRA_USERNAME` and `DB_CASSANDRA_PASSWORD` environment variables with
+your Cassandra username and password.
+
+### Starfield Digital Certificate for Amazon Keyspaces
+
+Before connecting to Amazon Keyspaces, you need to download and install the Starfield digital certificate that Amazon
+Keyspaces uses for TLS connections:
+
+1. Download the Starfield digital certificate:
+   ```bash
+   curl -O https://certs.secureserver.net/repository/sf-class2-root.crt
+   ```
+
+2. Place the certificate in the correct location:
+   ```bash
+   # If you installed the package from PyPI
+   mkdir -p ~/.keyspaces-mcp/certs
+   cp sf-class2-root.crt ~/.keyspaces-mcp/certs/
+
+   # If you installed from source
+   mkdir -p /path/to/mcp/src/amazon-keyspaces-mcp-server/awslabs/certs
+   cp sf-class2-root.crt /path/to/mcp/src/amazon-keyspaces-mcp-server/awslabs/certs/
+   ```
+
+The MCP server looks for the certificate in the `awslabs/certs` directory relative to the installation.
+
+## Running the MCP Server
+
+After installation, you can run the server directly:
+
+```bash
+awslabs.amazon-keyspaces-mcp-server
+```
+
+## Configuring Amazon Q to Use the MCP Server
+
+To use the Amazon Keyspaces MCP server with Amazon Q CLI, you need to configure it in your Q configuration file.
+
+### Configuration for Amazon Q CLI
+
+Edit the Q configuration file at `~/.config/amazon-q/config.json`:
+
+```json
+{
+  "mcpServers": [
+    {
+      "name": "keyspaces-mcp",
+      "command": "awslabs.amazon-keyspaces-mcp-server",
+      "args": [],
+      "env": {}
+    }
+  ]
+}
+```
+
+If the file doesn't exist yet or doesn't have an `mcpServers` section, create it with the structure shown above.
+
+Now when you use Q Chat by running `q chat`, it will automatically connect to your Keyspaces MCP server.
+
+## Available Tools
+
+The Amazon Keyspaces MCP server provides the following tools that AI assistants can use:
+
+- `listKeyspaces`: Lists all keyspaces in the database
+- `listTables`: Lists all tables in a specified keyspace
+- `describeKeyspace`: Gets detailed information about a keyspace
+- `describeTable`: Gets detailed information about a table
+- `executeQuery`: Executes a read-only SELECT query against the database
+- `analyzeQueryPerformance`: Analyzes the performance characteristics of a CQL query
+
+## Security Considerations
+
+- When using Amazon Keyspaces, ensure your IAM policies follow the principle of least privilege. While this
+MCP server does not mutate Keyspaces data or resources, it cannot prevent agent-driven attempts to (for example)
+invoke AWS SDK operations on your behalf, including mutating operations.
+- This MCP server only allows read-only SELECT queries to protect your data.
+- Queries are validated to prevent potentially harmful operations.
+
+## Troubleshooting
+
+### Connection Issues
+
+- Verify your database connection settings in the `.env` file.
+- Ensure your logged-in user has the necessary permissions for the operations performed by this server.
+- Check that your database is accessible from your network.
+- For Amazon Keyspaces, verify that the Starfield certificate is correctly installed in the `awslabs/certs` directory.
+- If you get SSL/TLS errors, check that the certificate path is correct and the certificate is valid.
+
+### Python Version Compatibility
+
+- The MCP server works best with Python 3.10 or 3.11.
+- Python 3.12+ may have issues due to the removal of the asyncore module which the Cassandra driver depends on.
+
+### Cassandra Driver Issues
+
+If you encounter issues with the Cassandra driver:
+
+1. Ensure you have the necessary C dependencies installed for the Cassandra driver.
+2. Try installing the driver with: `pip install cassandra-driver --no-binary :all:`
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

awslabs_amazon_keyspaces_mcp_server-0.0.1/README.md

@@ -0,0 +1,193 @@
+# AWS Labs amazon-keyspaces MCP Server
+
+An Amazon Keyspaces (for Apache Cassandra) MCP server for interacting with Amazon Keyspaces and Apache Cassandra.
+
+## Overview
+
+The Amazon Keyspaces MCP server implements the Model Context Protocol (MCP) to enable AI assistants like Amazon Q to
+interact with Amazon Keyspaces or Apache Cassandra databases through natural language. This server allows you to explore
+ database schemas, execute queries, and analyze query performance without having to write CQL code directly.
+
+## Features
+
+The Amazon Keyspaces (for Apache Cassandra) MCP server provides the following capabilities:
+1. **Schema**: Explore keyspaces and tables.
+2. **Run Queries**: Execute CQL SELECT queries against the configured database.
+3. **Query Analysis**: Get feedback and suggestions for improving query performance.
+4. **Cassandra-Compatible**: Use with Amazon Keyspaces, or with Apache Cassandra.
+
+Here are some example prompts that this MCP server can help with:
+- "List all keyspaces in my Cassandra database"
+- "Show me the tables in the 'sales' keyspace"
+- "Describe the 'users' table in the 'sales' keyspace"
+- "What's the schema of the 'products' table?"
+- "Run a SELECT query to get all users from the 'users' table in 'sales'"
+- "Query the first 10 records from the 'events' table"
+- "Analyze the performance of this query: SELECT * FROM users WHERE last_name = 'Smith'"
+- "Is this query efficient: SELECT * FROM orders WHERE order_date > '2023-01-01'?"
+
+## Installation
+
+### Prerequisites
+
+- Python 3.10 or 3.11 (Python 3.12+ is not fully supported due to asyncore module removal)
+- Access to an Amazon Keyspaces instance or Apache Cassandra cluster that supports password authentication
+- Appropriate Cassandra log-in credentials
+- Starfield digital certificate (required for Amazon Keyspaces)
+
+### Install from PyPI
+
+```bash
+pip install awslabs.amazon-keyspaces-mcp-server
+```
+
+### Install from Source
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/awslabs/mcp.git
+   cd mcp/src/amazon-keyspaces-mcp-server
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   ```
+
+3. Install the package:
+   ```bash
+   pip install -e .
+   ```
+
+## Configuration
+
+Create a `.env` file in your working directory with your database connection settings:
+
+```
+# Set to true for Amazon Keyspaces, false for Apache Cassandra
+DB_USE_KEYSPACES=true
+
+# Cassandra configuration (for native Cassandra)
+DB_CASSANDRA_CONTACT_POINTS=127.0.0.1
+DB_CASSANDRA_PORT=9042
+DB_CASSANDRA_LOCAL_DATACENTER=datacenter1
+DB_CASSANDRA_USERNAME=
+DB_CASSANDRA_PASSWORD=
+
+# Keyspaces configuration (for Amazon Keyspaces)
+DB_KEYSPACES_ENDPOINT=cassandra.us-west-2.amazonaws.com
+DB_KEYSPACES_REGION=us-west-2
+```
+
+### Authentication Credentials
+
+This MCP server uses username and password authentication for both Amazon Keyspaces and Apache Cassandra:
+
+- For **Amazon Keyspaces**: Set the `DB_CASSANDRA_USERNAME` and `DB_CASSANDRA_PASSWORD` environment variables with
+your Keyspaces username and password. These are the same service-specific credentials you would use to access Keyspaces
+via the Cassandra Query Language (CQL) shell.
+
+- For **Apache Cassandra**: Set the `DB_CASSANDRA_USERNAME` and `DB_CASSANDRA_PASSWORD` environment variables with
+your Cassandra username and password.
+
+### Starfield Digital Certificate for Amazon Keyspaces
+
+Before connecting to Amazon Keyspaces, you need to download and install the Starfield digital certificate that Amazon
+Keyspaces uses for TLS connections:
+
+1. Download the Starfield digital certificate:
+   ```bash
+   curl -O https://certs.secureserver.net/repository/sf-class2-root.crt
+   ```
+
+2. Place the certificate in the correct location:
+   ```bash
+   # If you installed the package from PyPI
+   mkdir -p ~/.keyspaces-mcp/certs
+   cp sf-class2-root.crt ~/.keyspaces-mcp/certs/
+
+   # If you installed from source
+   mkdir -p /path/to/mcp/src/amazon-keyspaces-mcp-server/awslabs/certs
+   cp sf-class2-root.crt /path/to/mcp/src/amazon-keyspaces-mcp-server/awslabs/certs/
+   ```
+
+The MCP server looks for the certificate in the `awslabs/certs` directory relative to the installation.
+
+## Running the MCP Server
+
+After installation, you can run the server directly:
+
+```bash
+awslabs.amazon-keyspaces-mcp-server
+```
+
+## Configuring Amazon Q to Use the MCP Server
+
+To use the Amazon Keyspaces MCP server with Amazon Q CLI, you need to configure it in your Q configuration file.
+
+### Configuration for Amazon Q CLI
+
+Edit the Q configuration file at `~/.config/amazon-q/config.json`:
+
+```json
+{
+  "mcpServers": [
+    {
+      "name": "keyspaces-mcp",
+      "command": "awslabs.amazon-keyspaces-mcp-server",
+      "args": [],
+      "env": {}
+    }
+  ]
+}
+```
+
+If the file doesn't exist yet or doesn't have an `mcpServers` section, create it with the structure shown above.
+
+Now when you use Q Chat by running `q chat`, it will automatically connect to your Keyspaces MCP server.
+
+## Available Tools
+
+The Amazon Keyspaces MCP server provides the following tools that AI assistants can use:
+
+- `listKeyspaces`: Lists all keyspaces in the database
+- `listTables`: Lists all tables in a specified keyspace
+- `describeKeyspace`: Gets detailed information about a keyspace
+- `describeTable`: Gets detailed information about a table
+- `executeQuery`: Executes a read-only SELECT query against the database
+- `analyzeQueryPerformance`: Analyzes the performance characteristics of a CQL query
+
+## Security Considerations
+
+- When using Amazon Keyspaces, ensure your IAM policies follow the principle of least privilege. While this
+MCP server does not mutate Keyspaces data or resources, it cannot prevent agent-driven attempts to (for example)
+invoke AWS SDK operations on your behalf, including mutating operations.
+- This MCP server only allows read-only SELECT queries to protect your data.
+- Queries are validated to prevent potentially harmful operations.
+
+## Troubleshooting
+
+### Connection Issues
+
+- Verify your database connection settings in the `.env` file.
+- Ensure your logged-in user has the necessary permissions for the operations performed by this server.
+- Check that your database is accessible from your network.
+- For Amazon Keyspaces, verify that the Starfield certificate is correctly installed in the `awslabs/certs` directory.
+- If you get SSL/TLS errors, check that the certificate path is correct and the certificate is valid.
+
+### Python Version Compatibility
+
+- The MCP server works best with Python 3.10 or 3.11.
+- Python 3.12+ may have issues due to the removal of the asyncore module which the Cassandra driver depends on.
+
+### Cassandra Driver Issues
+
+If you encounter issues with the Cassandra driver:
+
+1. Ensure you have the necessary C dependencies installed for the Cassandra driver.
+2. Try installing the driver with: `pip install cassandra-driver --no-binary :all:`
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the LICENSE file for details.