Skip to content

Commit a8a4e9c

Browse files
authored
docs: update readme (#39)
1 parent 43b5f16 commit a8a4e9c

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# README: AWS MCP Proxy
1+
# AWS MCP Proxy
22

33
AWS MCP Proxy Server
44

55
## Overview
66

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

9-
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.
9+
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.
1010

1111
## Prerequisites
1212

@@ -81,7 +81,7 @@ Add the following configuration to your MCP client config file (e.g., for Amazon
8181
```
8282
{
8383
"mcpServers": {
84-
"aws-mcp-proxy": {
84+
"<mcp server name>": {
8585
"disabled": false,
8686
"type": "stdio",
8787
"command": "uv",
@@ -111,7 +111,7 @@ Add the following configuration to your MCP client config file (e.g., for Amazon
111111
```
112112
{
113113
"mcpServers": {
114-
"aws-mcp-proxy": {
114+
"<mcp server name>": {
115115
"command": "docker",
116116
"args": [
117117
"run",
@@ -134,6 +134,12 @@ For development setup, testing, and contribution guidelines, see:
134134
* [DEVELOPMENT.md](DEVELOPMENT.md) - Development environment setup and testing
135135
* [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute to this project
136136

137+
Resources to understand SigV4:
138+
139+
- <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html>
140+
- SigV4: <https://github.com/boto/botocore/blob/develop/botocore/signers.py>
141+
- SigV4a: <https://github.com/aws-samples/sigv4a-signing-examples/blob/main/python/sigv4a_sign.py>
142+
137143
## License
138144

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

0 commit comments

Comments
 (0)