Skip to content

Commit c950d74

Browse files
authored
docs: update README (#226)
1 parent e5130f9 commit c950d74

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,22 @@ Or using a locally built image:
214214

215215
The MCP Proxy for AWS enables programmatic integration of IAM-secured MCP servers into AI agent frameworks. The library provides authenticated transport layers that work with popular Python AI frameworks.
216216

217+
By default, the library resolves AWS credentials automatically from the standard [boto3 credential chain](https://docs.aws.amazon.com/boto3/latest/guide/credentials.html#configuring-credentials) (environment variables, shared credentials file, etc.). You can optionally pass credentials programmatically via the `credentials` parameter. When provided, these take precedence over the `aws_profile` parameter. Note that `aws_region` must be explicitly specified when using `credentials`.
218+
219+
```python
220+
from botocore.credentials import Credentials
221+
from mcp_proxy_for_aws.client import aws_iam_streamablehttp_client
222+
223+
creds = Credentials(access_key="...", secret_key="...", token="...")
224+
225+
mcp_client = aws_iam_streamablehttp_client(
226+
endpoint=mcp_url,
227+
aws_region=region,
228+
aws_service=service,
229+
credentials=creds, # Optional: explicitly pass AWS credentials
230+
)
231+
```
232+
217233
### Integration Patterns
218234

219235
The library supports two integration patterns depending on your framework:

0 commit comments

Comments
 (0)