Skip to content

Commit 2742b4b

Browse files
Michael Christensenim-michaelc
authored andcommitted
Update documentation
1 parent 4ad7270 commit 2742b4b

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

src/amazon-keyspaces-mcp-server/README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# AWS Labs amazon-keyspaces MCP Server
1+
# AWS Labs Amazon Keyspaces MCP Server
22

33
An Amazon Keyspaces (for Apache Cassandra) MCP server for interacting with Amazon Keyspaces and Apache Cassandra.
44

55
## Overview
66

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
88
interact with Amazon Keyspaces or Apache Cassandra databases through natural language. This server allows you to explore
99
database schemas, execute queries, and analyze query performance without having to write CQL code directly.
1010

@@ -34,7 +34,7 @@ Here are some example prompts that this MCP server can help with:
3434

3535
### Prerequisites
3636

37-
- Python 3.10 or 3.11 (Python 3.12+ is not fully supported due to asyncore module removal)
37+
- Python 3.10+
3838
- Access to an Amazon Keyspaces instance or Apache Cassandra cluster that supports password authentication
3939
- Appropriate Cassandra log-in credentials
4040
- Starfield digital certificate (required for Amazon Keyspaces)
@@ -123,30 +123,36 @@ After installation, you can run the server directly:
123123
awslabs.amazon-keyspaces-mcp-server
124124
```
125125

126-
## Configuring Amazon Q to Use the MCP Server
126+
## Configuring Kiro CLI to Use the MCP Server
127127

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.
129129

130-
### Configuration for Amazon Q CLI
130+
### Configuration for Kiro CLI
131131

132-
Edit the Q configuration file at `~/.aws/amazonq/mcp.json`:
132+
Edit the Kiro configuration file at `~/.kiro/settings/mcp.json`:
133133

134134
```json
135135
{
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" : []
142147
}
143-
]
148+
}
149+
144150
}
145151
```
146152

147153
### Windows Installation
148154

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:
150156

151157
```json
152158
{
@@ -176,7 +182,7 @@ For Windows users, the MCP server configuration format is slightly different. Ed
176182

177183
If the file doesn't exist yet or doesn't have an `mcpServers` section, create it with the structure shown above.
178184

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.
180186

181187
## Available Tools
182188

@@ -207,11 +213,6 @@ invoke AWS SDK operations on your behalf, including mutating operations.
207213
- For Amazon Keyspaces, verify that the Starfield certificate is correctly installed in the `.keyspaces-mcp/certs` directory.
208214
- If you get SSL/TLS errors, check that the certificate path is correct and the certificate is valid.
209215

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-
215216
### Cassandra Driver Issues
216217

217218
If you encounter issues with the Cassandra driver:

src/amazon-keyspaces-mcp-server/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ authors = [
1919
{name = "Amazon Web Services"},
2020
{name = "AWSLabs MCP", email="[email protected]"},
2121
{name = "Joel Shepherd", email="[email protected]"},
22+
{name = "Michael Christensen", email="[email protected]"},
2223
]
2324
classifiers = [
2425
"License :: OSI Approved :: Apache Software License",

0 commit comments

Comments
 (0)