public/mcp-database-server
1
0
Fork 0
mirror of https://github.com/executeautomation/mcp-database-server.git synced 2025-12-09 21:12:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add AWS credentials configuration prerequisites

Browse Source 
- Document requirement for AWS credentials configuration using default provider chain
- Add examples for different credential configuration methods (aws configure, env vars, IAM roles)
- Update both README.md and connection reference documentation
- Clarify that RDS Signer uses default credential provider chain as per AWS documentation
This commit is contained in:
Fabrizio Ferrigno
2025-07-17 15:35:44 +02:00
parent 72325c95a3
commit c72bac7a87
2 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/connection-reference.md
View File

@@ -94,6 +94,12 @@ node dist/src/index.js --mysql --host localhost --database sample_db --port 3306
### AWS IAM Authentication Example ### AWS IAM Authentication Example
**Prerequisites:** AWS credentials must be configured using the default credential provider chain:
- `aws configure` (default profile)
- `AWS_PROFILE=myprofile` environment variable
- `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
- IAM roles (if running on EC2)
```bash ```bash
node dist/src/index.js --mysql --aws-iam-auth --host rds-endpoint.region.rds.amazonaws.com --database sample_db --user aws-username --aws-region us-east-1 node dist/src/index.js --mysql --aws-iam-auth --host rds-endpoint.region.rds.amazonaws.com --database sample_db --user aws-username --aws-region us-east-1
``` ```

8
readme.md
View File

@@ -117,6 +117,14 @@ Optional parameters:
For Amazon RDS MySQL instances with IAM database authentication: For Amazon RDS MySQL instances with IAM database authentication:
**Prerequisites:**
- AWS credentials must be configured (the RDS Signer uses the default credential provider chain)
- Configure using one of these methods:
- `aws configure` (uses default profile)
- `AWS_PROFILE=myprofile` environment variable
- `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
- IAM roles (if running on EC2)
``` ```
node dist/src/index.js --mysql --aws-iam-auth --host <rds-endpoint> --database <database-name> --user <aws-username> --aws-region <region> node dist/src/index.js --mysql --aws-iam-auth --host <rds-endpoint> --database <database-name> --user <aws-username> --aws-region <region>
``` ```