|
1 | | -# AWS Labs amazon-keyspaces MCP Server |
| 1 | +# AWS Labs Amazon Keyspaces MCP Server |
2 | 2 |
|
3 | 3 | An Amazon Keyspaces (for Apache Cassandra) MCP server for interacting with Amazon Keyspaces and Apache Cassandra. |
4 | 4 |
|
5 | 5 | ## Overview |
6 | 6 |
|
7 | | -The Amazon Keyspaces MCP server implements the Model Context Protocol (MCP) to enable AI assistants like Amazon Q to |
| 7 | +The Amazon Keyspaces MCP server implements the Model Context Protocol (MCP) to enable AI assistants like Kiro to |
8 | 8 | interact with Amazon Keyspaces or Apache Cassandra databases through natural language. This server allows you to explore |
9 | 9 | database schemas, execute queries, and analyze query performance without having to write CQL code directly. |
10 | 10 |
|
@@ -34,7 +34,7 @@ Here are some example prompts that this MCP server can help with: |
34 | 34 |
|
35 | 35 | ### Prerequisites |
36 | 36 |
|
37 | | -- Python 3.10 or 3.11 (Python 3.12+ is not fully supported due to asyncore module removal) |
| 37 | +- Python 3.10+ |
38 | 38 | - Access to an Amazon Keyspaces instance or Apache Cassandra cluster that supports password authentication |
39 | 39 | - Appropriate Cassandra log-in credentials |
40 | 40 | - Starfield digital certificate (required for Amazon Keyspaces) |
@@ -123,30 +123,36 @@ After installation, you can run the server directly: |
123 | 123 | awslabs.amazon-keyspaces-mcp-server |
124 | 124 | ``` |
125 | 125 |
|
126 | | -## Configuring Amazon Q to Use the MCP Server |
| 126 | +## Configuring Kiro CLI to Use the MCP Server |
127 | 127 |
|
128 | | -To use the Amazon Keyspaces MCP server with Amazon Q CLI, you need to configure it in your Q configuration file. |
| 128 | +To use the Amazon Keyspaces MCP server with Kiro CLI, you need to configure it in your Kiro configuration file. |
129 | 129 |
|
130 | | -### Configuration for Amazon Q CLI |
| 130 | +### Configuration for Kiro CLI |
131 | 131 |
|
132 | | -Edit the Q configuration file at `~/.aws/amazonq/mcp.json`: |
| 132 | +Edit the Kiro configuration file at `~/.kiro/settings/mcp.json`: |
133 | 133 |
|
134 | 134 | ```json |
135 | 135 | { |
136 | | - "mcpServers": [ |
137 | | - { |
138 | | - "name": "keyspaces-mcp", |
139 | | - "command": "awslabs.amazon-keyspaces-mcp-server", |
140 | | - "args": [], |
141 | | - "env": {} |
| 136 | + "mcpServers": { |
| 137 | + "aws-labs-keyspaces-mcp" : { |
| 138 | + "command" : "uvx", |
| 139 | + "args" : ["awslabs.amazon-keyspaces-mcp-server@latest"], |
| 140 | + "env" : { |
| 141 | + "AWS_PROFILE" : "your-aws-profile", |
| 142 | + "AWS_REGION" : "us-east-1", |
| 143 | + "FASTMCP_LOG_LEVEL" : "ERROR" |
| 144 | + }, |
| 145 | + "disabled" : false, |
| 146 | + "autoApprove" : [] |
142 | 147 | } |
143 | | - ] |
| 148 | + } |
| 149 | + |
144 | 150 | } |
145 | 151 | ``` |
146 | 152 |
|
147 | 153 | ### Windows Installation |
148 | 154 |
|
149 | | -For Windows users, the MCP server configuration format is slightly different. Edit your MCP configuration file (e.g., `~/.aws/amazonq/mcp.json` for Amazon Q CLI) with the following format: |
| 155 | +For Windows users, the MCP server configuration format is slightly different. Edit your MCP configuration file (e.g., `~/.kiro/settings/mcp.json` for Kiro CLI) with the following format: |
150 | 156 |
|
151 | 157 | ```json |
152 | 158 | { |
@@ -176,7 +182,7 @@ For Windows users, the MCP server configuration format is slightly different. Ed |
176 | 182 |
|
177 | 183 | If the file doesn't exist yet or doesn't have an `mcpServers` section, create it with the structure shown above. |
178 | 184 |
|
179 | | -Now when you use Q Chat by running `q chat`, it will automatically connect to your Keyspaces MCP server. |
| 185 | +Now when you use Kiro CLI by running `kiro-cli chat`, it will automatically connect to your Keyspaces MCP server. |
180 | 186 |
|
181 | 187 | ## Available Tools |
182 | 188 |
|
@@ -207,11 +213,6 @@ invoke AWS SDK operations on your behalf, including mutating operations. |
207 | 213 | - For Amazon Keyspaces, verify that the Starfield certificate is correctly installed in the `.keyspaces-mcp/certs` directory. |
208 | 214 | - If you get SSL/TLS errors, check that the certificate path is correct and the certificate is valid. |
209 | 215 |
|
210 | | -### Python Version Compatibility |
211 | | - |
212 | | -- The MCP server works best with Python 3.10 or 3.11. |
213 | | -- Python 3.12+ may have issues due to the removal of the asyncore module which the Cassandra driver depends on. |
214 | | - |
215 | 216 | ### Cassandra Driver Issues |
216 | 217 |
|
217 | 218 | If you encounter issues with the Cassandra driver: |
|
0 commit comments