Skip to content

Commit 7640e44

Browse files
committed
add simple initial AGENTS.md file
1 parent a25f189 commit 7640e44

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

aws-proxy/AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AI Agent Instructions for AWS Proxy Extension
2+
3+
This repo is a LocalStack extension (plugin) that enables a "proxy mode" - proxying requests for certain AWS services (e.g., S3) to the upstream real AWS cloud, while handling the remaining services locally.
4+
5+
## Testing
6+
7+
The proxy functionality is covered by integration tests in the `tests/` folder, one file for each different service.
8+
9+
To add a test, follow the pattern in the existing tests.
10+
It usually involves creating two boto3 clients, one for the LocalStack connection, and one for the real upstream AWS cloud.
11+
We then run API requests with both clients and assert that the results are identical, thereby ensuring that the proxy functionality is working properly.
12+
13+
You can assume that test AWS credentials are configured in the shell environment where the AI agent is running.

0 commit comments

Comments
 (0)