Skip to content

Commit ab9705d

Browse files
committed
docs: add links to docs/cognito.md in README.md
- Added link to Cognito setup guide in What's New section - Added link in Prerequisites section alongside auth.md reference - Added link in Access the Registry section for Cognito authentication option - Added helpful comments with links in agent configuration sections - Provides users with direct access to detailed Cognito setup instructions
1 parent 105a213 commit ab9705d

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can deploy the gateway and registry on Amazon EC2 or Amazon EKS for producti
3030

3131
## What's New
3232

33-
* **IdP Integration with Amazon Cognito:** Complete identity provider integration supporting both user identity and agent identity modes
33+
* **IdP Integration with Amazon Cognito:** Complete identity provider integration supporting both user identity and agent identity modes. See [detailed Cognito setup guide](docs/cognito.md) for configuration instructions.
3434
* **Fine-Grained Access Control (FGAC) for MCP servers and tools:** Granular permissions system allowing precise control over which agents can access specific servers and tools
3535
* **Integration with [Strands Agents](https://github.com/strands-agents/sdk-python):** Enhanced agent capabilities with the Strands SDK
3636
* **Dynamic tool discovery and invocation:** User agents can discover new tools through the registry and have limitless capabilities
@@ -197,7 +197,7 @@ flowchart TB
197197

198198
* **External API Keys (Optional):** One of the example MCP servers uses the [`Polygon`](https://polygon.io/stocks) API for stock ticker data. Get an API key from [here](https://polygon.io/dashboard/signup?redirect=%2Fdashboard%2Fkeys). The server will still start without the API key but you will get a 401 Unauthorized error when using the tools provided by this server.
199199

200-
* **Authentication Setup:** Setup authentication using Amazon Cognito as per instructions [here](docs/auth.md).
200+
* **Authentication Setup:** Setup authentication using Amazon Cognito as per instructions [here](docs/auth.md). For detailed Cognito configuration, see the [Cognito setup guide](docs/cognito.md).
201201

202202
## Installation
203203

@@ -262,6 +262,7 @@ The deployment includes these containers:
262262
- Click "Login with Cognito" to authenticate via your configured Cognito User Pool
263263
- Access permissions will be based on the Cognito group you are a member of
264264
- Provides fine-grained access control based on your organizational roles
265+
- For detailed Cognito setup instructions, see [docs/cognito.md](docs/cognito.md)
265266

266267
**Option 2 - Username/Password (Testing Only):**
267268
- Use the traditional login with:
@@ -324,6 +325,7 @@ For production deployments with SSL certificates:
324325
```bash
325326
cp agents/.env.template agents/.env.user
326327
# Edit agents/.env.user with your Cognito configuration
328+
# See [`docs/cognito.md`](docs/cognito.md) for detailed Cognito setup instructions
327329
```
328330

329331
2. **Authenticate with user identity:**
@@ -348,6 +350,7 @@ For production deployments with SSL certificates:
348350
```bash
349351
cp agents/.env.template agents/.env.agent
350352
# Edit agents/.env.agent with your Cognito configuration
353+
# See docs/cognito.md for detailed Cognito setup instructions
351354
```
352355

353356
2. **Run the agent with agentic identity:**

0 commit comments

Comments
 (0)