Skip to content

docs: update readme #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wzxxing merged 1 commit into from
Oct 7, 2025
Merged

docs: update readme #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# README: AWS MCP Proxy
# AWS MCP Proxy

AWS MCP Proxy Server

## Overview

The AWS MCP Proxy serves as a lightweight, client-side bridge between MCP clients (AI assistants and developer tools) and backend AWS MCP servers.

The proxy handles SigV4 authentication using local AWS credentials and provides dynamic tool discovery, making it ideal for developers who want direct service access without complex gateway setups.
The proxy handles [SigV4](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) authentication using local AWS credentials and provides dynamic tool discovery, making it ideal for developers who want direct service access without complex gateway setups.

## Prerequisites

Expand Down Expand Up @@ -81,7 +81,7 @@ Add the following configuration to your MCP client config file (e.g., for Amazon
```
{
"mcpServers": {
"aws-mcp-proxy": {
"<mcp server name>": {
"disabled": false,
"type": "stdio",
"command": "uv",
Expand Down Expand Up @@ -111,7 +111,7 @@ Add the following configuration to your MCP client config file (e.g., for Amazon
```
{
"mcpServers": {
"aws-mcp-proxy": {
"<mcp server name>": {
"command": "docker",
"args": [
"run",
Expand All @@ -134,6 +134,12 @@ For development setup, testing, and contribution guidelines, see:
* [DEVELOPMENT.md](DEVELOPMENT.md) - Development environment setup and testing
* [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute to this project

Resources to understand SigV4:

- <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html>
- SigV4: <https://github.com/boto/botocore/blob/develop/botocore/signers.py>
- SigV4a: <https://github.com/aws-samples/sigv4a-signing-examples/blob/main/python/sigv4a_sign.py>

## License

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Expand Down