Skip to content

Commit c3aa882

Browse files
prajwalendraprajwalendra
committed
Switch to Just the Docs theme with left navigation
- Use just-the-docs theme for better navigation - Add left sidebar navigation panel - Add search functionality - Add back to top button - Improve home page layout with buttons - Add footer with license info - Enable mermaid diagrams support - Add callout styling for notes/warnings
1 parent e30f868 commit c3aa882

2 files changed

Lines changed: 103 additions & 36 deletions

File tree

‎docs/_config.yml‎

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Site settings
2-
title: Amazon Bedrock AgentCore Gateway User Federation
2+
title: AgentCore Gateway User Federation
33
description: >-
44
Expose OAuth 2.0-secured APIs as MCP tools for AI agents while preserving
55
user authentication context using Amazon Bedrock AgentCore Gateway Interceptors.
@@ -9,8 +9,9 @@ url: "https://aws-samples.github.io"
99
# Repository
1010
repository: aws-samples/sample-bedrock-agentcore-gateway-user-federation
1111

12-
# Theme
13-
remote_theme: pages-themes/cayman@v0.2.0
12+
# Theme - Just the Docs for left navigation
13+
remote_theme: just-the-docs/just-the-docs@v0.10.1
14+
color_scheme: light
1415

1516
# Plugins
1617
plugins:
@@ -19,6 +20,41 @@ plugins:
1920
- jekyll-sitemap
2021
- jekyll-relative-links
2122

23+
# Aux links (top right)
24+
aux_links:
25+
"View on GitHub":
26+
- "https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation"
27+
28+
aux_links_new_tab: true
29+
30+
# Footer
31+
footer_content: >-
32+
Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.
33+
<br>
34+
Licensed under the <a href="https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation/blob/main/LICENSE">MIT-0 License</a>.
35+
36+
# Back to top link
37+
back_to_top: true
38+
back_to_top_text: "Back to top"
39+
40+
# Navigation structure
41+
nav_enabled: true
42+
nav_sort: case_sensitive
43+
44+
# Search
45+
search_enabled: true
46+
search:
47+
heading_level: 2
48+
previews: 3
49+
preview_words_before: 5
50+
preview_words_after: 10
51+
tokenizer_separator: /[\s/]+/
52+
rel_url: true
53+
button: false
54+
55+
# Heading anchor links
56+
heading_anchors: true
57+
2258
# Relative links
2359
relative_links:
2460
enabled: true
@@ -31,6 +67,10 @@ kramdown:
3167
hard_wrap: false
3268
syntax_highlighter: rouge
3369

70+
# Mermaid diagrams
71+
mermaid:
72+
version: "10.6.0"
73+
3474
# Encoding
3575
encoding: UTF-8
3676

@@ -56,3 +96,15 @@ social:
5696
name: AWS Samples
5797
links:
5898
- https://github.com/aws-samples
99+
100+
# Callouts
101+
callouts:
102+
warning:
103+
title: Warning
104+
color: red
105+
note:
106+
title: Note
107+
color: blue
108+
tip:
109+
title: Tip
110+
color: green

‎docs/index.md‎

Lines changed: 48 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,79 @@
11
---
2-
layout: default
2+
layout: home
33
title: Home
44
nav_order: 1
55
description: "Expose OAuth 2.0-secured APIs as MCP tools for AI agents while preserving user authentication context"
66
permalink: /
77
---
88

9-
# Amazon Bedrock AgentCore Gateway User Federation
9+
# AgentCore Gateway User Federation
10+
{: .fs-9 }
1011

11-
This sample demonstrates how to expose existing OAuth 2.0-secured APIs as MCP (Model Context Protocol) tools for AI agents while preserving user authentication context using Amazon Bedrock AgentCore Gateway Interceptors.
12+
Expose OAuth 2.0-secured APIs as MCP tools for AI agents while preserving user authentication context using Amazon Bedrock AgentCore Gateway Interceptors.
13+
{: .fs-6 .fw-300 }
1214

13-
## Key Features
15+
[Get Started](SETUP.md){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
16+
[View on GitHub](https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation){: .btn .fs-5 .mb-4 .mb-md-0 }
1417

15-
- **USER_FEDERATION pattern** - JWT propagation through the entire request chain
16-
- **Three-layer JWT validation** - Runtime, Gateway, and API Gateway
17-
- **Gateway Interceptor** - Authorization header injection to downstream APIs
18-
- **CUSTOM_JWT authorizer** - Works with any OIDC provider (Okta, Auth0, Azure AD, Amazon Cognito)
18+
---
1919

20-
## Documentation
20+
## Overview
2121

22-
| Guide | Description |
23-
|-------|-------------|
24-
| [Architecture](ARCHITECTURE.md) | System architecture and component overview |
25-
| [Setup](SETUP.md) | Local development setup guide |
26-
| [Deployment](DEPLOYMENT.md) | AWS deployment instructions |
27-
| [Security](SECURITY.md) | Security considerations and best practices |
22+
This sample demonstrates the **USER_FEDERATION** pattern for Amazon Bedrock AgentCore, enabling AI agents to access user-specific data through existing OAuth 2.0-secured APIs while maintaining the original user's authentication context.
2823

29-
## Quick Start
24+
### Key Features
3025

31-
```bash
32-
git clone https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation.git
33-
cd sample-bedrock-agentcore-gateway-user-federation
34-
./deploy.sh
35-
```
26+
| Feature | Description |
27+
|:--------|:------------|
28+
| **USER_FEDERATION** | JWT propagation through the entire request chain |
29+
| **Three-layer validation** | Independent JWT validation at Runtime, Gateway, and API Gateway |
30+
| **Gateway Interceptor** | Authorization header injection to downstream APIs |
31+
| **OIDC Compatible** | Works with Okta, Auth0, Azure AD, Amazon Cognito |
3632

37-
See the [Setup Guide](SETUP.md) for detailed instructions.
33+
---
3834

39-
## Architecture Overview
35+
## Architecture
4036

41-
The solution uses Amazon Bedrock AgentCore Gateway with a custom Interceptor Lambda to bridge the gap between AI agent tool calls and your OAuth-protected APIs. The Gateway validates incoming JWTs but doesn't automatically forward them to downstream targets. The Interceptor Lambda handles this critical step.
37+
The solution uses Amazon Bedrock AgentCore Gateway with a custom Interceptor Lambda to bridge the gap between AI agent tool calls and your OAuth-protected APIs.
4238

4339
### Components
4440

4541
| Component | Purpose |
46-
|-----------|---------|
42+
|:----------|:--------|
4743
| Amazon CloudFront | Hosts frontend and routes API requests |
4844
| AWS App Runner | Backend service that invokes AgentCore |
49-
| Amazon Bedrock AgentCore Runtime | Hosts and executes the AI agent |
50-
| Amazon Bedrock AgentCore Gateway | MCP server exposing APIs as tools |
45+
| AgentCore Runtime | Hosts and executes the AI agent |
46+
| AgentCore Gateway | MCP server exposing APIs as tools |
5147
| Interceptor Lambda | Extracts JWT and injects into outbound requests |
5248
| Amazon API Gateway | HTTP API with JWT authorizer |
5349

54-
## Security
50+
---
5551

56-
This project implements defense-in-depth security with JWT validation at multiple layers. See the [Security Guide](SECURITY.md) for details.
52+
## Quick Start
53+
54+
```bash
55+
git clone https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation.git
56+
cd sample-bedrock-agentcore-gateway-user-federation
57+
./deploy.sh
58+
```
59+
60+
See the [Setup Guide](SETUP.md) for detailed instructions.
61+
62+
---
63+
64+
## Documentation
65+
66+
- [Architecture](ARCHITECTURE.md) - System architecture and component overview
67+
- [Setup](SETUP.md) - Local development setup guide
68+
- [Deployment](DEPLOYMENT.md) - AWS deployment instructions
69+
- [Security](SECURITY.md) - Security considerations and best practices
70+
71+
---
5772

58-
## License
73+
## About
5974

60-
This library is licensed under the MIT-0 License. See the [LICENSE](https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation/blob/main/LICENSE) file.
75+
This project is maintained by [AWS Samples](https://github.com/aws-samples) and licensed under the [MIT-0 License](https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation/blob/main/LICENSE).
6176

62-
## Contributing
77+
### Contributing
6378

64-
See [CONTRIBUTING](https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation/blob/main/CONTRIBUTING.md) for information on how to contribute to this project.
79+
Contributions are welcome! See [CONTRIBUTING.md](https://github.com/aws-samples/sample-bedrock-agentcore-gateway-user-federation/blob/main/CONTRIBUTING.md) for guidelines.

0 commit comments

Comments
 (0)