AWS bedrock-agentcore documentation change
Summary
Updated documentation to consistently use 'AG-UI' (with hyphen) instead of 'AGUI' throughout the file, including headings, body text, and code comments.
Security assessment
The changes are purely branding/naming convention updates from 'AGUI' to 'AG-UI'. No security vulnerabilities, weaknesses, or incidents are mentioned or addressed. The change does not modify any security-related content such as authentication mechanisms, port configurations, or protocol security details.
Diff
diff --git a/bedrock-agentcore/latest/devguide/runtime-agui.md b/bedrock-agentcore/latest/devguide/runtime-agui.md index d435fb701..aaef58b16 100644 --- a//bedrock-agentcore/latest/devguide/runtime-agui.md +++ b//bedrock-agentcore/latest/devguide/runtime-agui.md @@ -7 +7 @@ -How Amazon Bedrock AgentCore supports AGUIUsing AGUI with AgentCore RuntimeAppendix +How Amazon Bedrock AgentCore supports AG-UIUsing AG-UI with AgentCore RuntimeAppendix @@ -9 +9 @@ How Amazon Bedrock AgentCore supports AGUIUsing AGUI with AgentCore RuntimeAppen -# Deploy AGUI servers in AgentCore Runtime +# Deploy AG-UI servers in AgentCore Runtime @@ -11 +11 @@ How Amazon Bedrock AgentCore supports AGUIUsing AGUI with AgentCore RuntimeAppen -Amazon Bedrock AgentCore AgentCore Runtime lets you deploy and run Agent User Interface (AGUI) servers in the AgentCore Runtime. This guide walks you through creating, testing, and deploying your first AGUI server. +Amazon Bedrock AgentCore Runtime lets you deploy and run Agent User Interface (AG-UI) servers in the AgentCore Runtime. This guide walks you through creating, testing, and deploying your first AG-UI server. @@ -15 +15 @@ In this section, you learn: - * How Amazon Bedrock AgentCore supports AGUI + * How Amazon Bedrock AgentCore supports AG-UI @@ -17 +17 @@ In this section, you learn: - * How to create an AGUI server + * How to create an AG-UI server @@ -28 +28 @@ In this section, you learn: -For more information about AGUI, see [AGUI protocol contract](./runtime-agui-protocol-contract.html). +For more information about AG-UI, see [AG-UI protocol contract](./runtime-agui-protocol-contract.html). @@ -32 +32 @@ For more information about AGUI, see [AGUI protocol contract](./runtime-agui-pro - * How Amazon Bedrock AgentCore supports AGUI + * How Amazon Bedrock AgentCore supports AG-UI @@ -34 +34 @@ For more information about AGUI, see [AGUI protocol contract](./runtime-agui-pro - * Using AGUI with AgentCore Runtime + * Using AG-UI with AgentCore Runtime @@ -41 +41 @@ For more information about AGUI, see [AGUI protocol contract](./runtime-agui-pro -## How Amazon Bedrock AgentCore supports AGUI +## How Amazon Bedrock AgentCore supports AG-UI @@ -43 +43 @@ For more information about AGUI, see [AGUI protocol contract](./runtime-agui-pro -Amazon Bedrock AgentCore’s AGUI protocol support enables integration with agent user interface servers by acting as a proxy layer. When configured for AGUI, Amazon Bedrock AgentCore expects containers to run servers on port `8080` at the `/invocations` path for HTTP/SSE or `/ws` for WebSocket connections. Although AGUI uses the same port and paths as the HTTP protocol, the runtime distinguishes between them based on the `--protocol` flag specified during deployment configuration. +Amazon Bedrock AgentCore’s AG-UI protocol support enables integration with agent user interface servers by acting as a proxy layer. When configured for AG-UI, Amazon Bedrock AgentCore expects containers to run servers on port `8080` at the `/invocations` path for HTTP/SSE or `/ws` for WebSocket connections. Although AG-UI uses the same port and paths as the HTTP protocol, the runtime distinguishes between them based on the `--protocol` flag specified during deployment configuration. @@ -45 +45 @@ Amazon Bedrock AgentCore’s AGUI protocol support enables integration with agen -Amazon Bedrock AgentCore acts as a proxy between clients and your AGUI container. Requests from the [InvokeAgentRuntime](https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_InvokeAgentRuntime.html) API are passed through to your container without modification. Amazon Bedrock AgentCore handles authentication (SigV4/OAuth 2.0), session isolation, and scaling. +Amazon Bedrock AgentCore acts as a proxy between clients and your AG-UI container. Requests from the [InvokeAgentRuntime](https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_InvokeAgentRuntime.html) API are passed through to your container without modification. Amazon Bedrock AgentCore handles authentication (SigV4/OAuth 2.0), session isolation, and scaling. @@ -52 +52 @@ Key differences from other protocols: -AGUI servers run on port 8080 (same as HTTP, vs 8000 for MCP, 9000 for A2A) +AG-UI servers run on port 8080 (same as HTTP, vs 8000 for MCP, 9000 for A2A) @@ -57 +57 @@ AGUI servers run on port 8080 (same as HTTP, vs 8000 for MCP, 9000 for A2A) -AGUI servers use `/invocations` for HTTP/SSE and `/ws` for WebSocket (same as HTTP protocol) +AG-UI servers use `/invocations` for HTTP/SSE and `/ws` for WebSocket (same as HTTP protocol) @@ -76 +76 @@ For more information, see [https://docs.ag-ui.com/introduction](https://docs.ag- -## Using AGUI with AgentCore Runtime +## Using AG-UI with AgentCore Runtime @@ -78 +78 @@ For more information, see [https://docs.ag-ui.com/introduction](https://docs.ag- -In this tutorial you create, test, and deploy an AGUI server. +In this tutorial you create, test, and deploy an AG-UI server. @@ -80 +80 @@ In this tutorial you create, test, and deploy an AGUI server. -For complete examples and framework-specific implementations, see [AGUI Quickstart Documentation](https://docs.ag-ui.com/quickstart/introduction) and [AGUI Dojo](https://dojo.ag-ui.com/). +For complete examples and framework-specific implementations, see [AG-UI Quickstart Documentation](https://docs.ag-ui.com/quickstart/introduction) and [AG-UI Dojo](https://dojo.ag-ui.com/). @@ -86 +86 @@ For complete examples and framework-specific implementations, see [AGUI Quicksta - * Step 1: Create your AGUI server + * Step 1: Create your AG-UI server @@ -88 +88 @@ For complete examples and framework-specific implementations, see [AGUI Quicksta - * Step 2: Test your AGUI server locally + * Step 2: Test your AG-UI server locally @@ -90 +90 @@ For complete examples and framework-specific implementations, see [AGUI Quicksta - * Step 3: Deploy your AGUI server to Bedrock AgentCore Runtime + * Step 3: Deploy your AG-UI server to Bedrock AgentCore Runtime @@ -92 +92 @@ For complete examples and framework-specific implementations, see [AGUI Quicksta - * Step 4: Invoke your deployed AGUI server + * Step 4: Invoke your deployed AG-UI server @@ -103 +103 @@ For complete examples and framework-specific implementations, see [AGUI Quicksta - * Understanding of the AGUI protocol and event-based agent-to-user communication concepts + * Understanding of the AG-UI protocol and event-based agent-to-user communication concepts @@ -108 +108 @@ For complete examples and framework-specific implementations, see [AGUI Quicksta -### Step 1: Create your AGUI server +### Step 1: Create your AG-UI server @@ -110 +110 @@ For complete examples and framework-specific implementations, see [AGUI Quicksta -AGUI is supported by multiple agent frameworks. Choose the framework that best fits your needs. For this example, we’ll show the general pattern. +AG-UI is supported by multiple agent frameworks. Choose the framework that best fits your needs. For this example, we’ll show the general pattern. @@ -114 +114 @@ AGUI is supported by multiple agent frameworks. Choose the framework that best f -Install packages for AWS Strands with AGUI support: +Install packages for AWS Strands with AG-UI support: @@ -121 +121 @@ Install packages for AWS Strands with AGUI support: -For other frameworks, see the [AGUI framework integrations](https://docs.ag-ui.com/introduction#supported-integrations). +For other frameworks, see the [AG-UI framework integrations](https://docs.ag-ui.com/introduction#supported-integrations). @@ -123 +123 @@ For other frameworks, see the [AGUI framework integrations](https://docs.ag-ui.c -#### Create your first AGUI server +#### Create your first AG-UI server @@ -125 +125 @@ For other frameworks, see the [AGUI framework integrations](https://docs.ag-ui.c -Create a new file called `my_agui_server.py` . This example uses AWS Strands with AGUI: +Create a new file called `my_agui_server.py` . This example uses AWS Strands with AG-UI: @@ -149 +149 @@ Create a new file called `my_agui_server.py` . This example uses AWS Strands wit - # Wrap with AGUI protocol support + # Wrap with AG-UI protocol support @@ -161 +161 @@ Create a new file called `my_agui_server.py` . This example uses AWS Strands wit - """Main AGUI endpoint that returns event streams.""" + """Main AG-UI endpoint that returns event streams.""" @@ -184 +184 @@ For complete, framework-specific examples, see: - * [LangGraph + AGUI](https://docs.copilotkit.ai/langgraph/) + * [LangGraph + AG-UI](https://docs.copilotkit.ai/langgraph/) @@ -186 +186 @@ For complete, framework-specific examples, see: - * [CrewAI + AGUI](https://docs.copilotkit.ai/crewai-flows) + * [CrewAI + AG-UI](https://docs.copilotkit.ai/crewai-flows) @@ -188 +188 @@ For complete, framework-specific examples, see: - * [AWS Strands + AGUI](https://docs.copilotkit.ai/aws-strands) + * [AWS Strands + AG-UI](https://docs.copilotkit.ai/aws-strands) @@ -198 +198 @@ For complete, framework-specific examples, see: -AGUI uses Server-Sent Events (SSE) to stream typed events to the client +AG-UI uses Server-Sent Events (SSE) to stream typed events to the client @@ -208 +208 @@ Primary endpoint for HTTP/SSE communication (same as HTTP protocol) -AGUI servers run on port 8080 by default in AgentCore Runtime +AG-UI servers run on port 8080 by default in AgentCore Runtime @@ -210 +210 @@ AGUI servers run on port 8080 by default in AgentCore Runtime -### Step 2: Test your AGUI server locally +### Step 2: Test your AG-UI server locally @@ -212 +212 @@ AGUI servers run on port 8080 by default in AgentCore Runtime -Run and test your AGUI server in a local development environment. +Run and test your AG-UI server in a local development environment. @@ -214 +214 @@ Run and test your AGUI server in a local development environment. -#### Start your AGUI server +#### Start your AG-UI server @@ -216 +216 @@ Run and test your AGUI server in a local development environment. -Run your AGUI server locally: +Run your AG-UI server locally: @@ -225 +225 @@ You should see output indicating the server is running on port `8080`. -Test the SSE endpoint with a properly formatted AGUI request: +Test the SSE endpoint with a properly formatted AG-UI request: @@ -240 +240 @@ Test the SSE endpoint with a properly formatted AGUI request: -You should see AGUI event streams returned in SSE format, including `RUN_STARTED` , `TEXT_MESSAGE_CONTENT` , and `RUN_FINISHED` events. +You should see AG-UI event streams returned in SSE format, including `RUN_STARTED` , `TEXT_MESSAGE_CONTENT` , and `RUN_FINISHED` events. @@ -242 +242 @@ You should see AGUI event streams returned in SSE format, including `RUN_STARTED -### Step 3: Deploy your AGUI server to Bedrock AgentCore Runtime +### Step 3: Deploy your AG-UI server to Bedrock AgentCore Runtime @@ -244 +244 @@ You should see AGUI event streams returned in SSE format, including `RUN_STARTED -Deploy your AGUI server to AWS using the Amazon Bedrock AgentCore starter toolkit. +Deploy your AG-UI server to AWS using the Amazon Bedrock AgentCore starter toolkit. @@ -272 +272 @@ Configure authentication for secure access to your deployed server. For detailed -#### Configure your AGUI server for deployment +#### Configure your AG-UI server for deployment @@ -298 +298 @@ After deployment, you’ll receive an agent runtime ARN that looks like: -### Step 4: Invoke your deployed AGUI server +### Step 4: Invoke your deployed AG-UI server @@ -300 +300 @@ After deployment, you’ll receive an agent runtime ARN that looks like: -Invoke your deployed Amazon Bedrock AgentCore AGUI server and interact with the event streams. +Invoke your deployed Amazon Bedrock AgentCore AG-UI server and interact with the event streams. @@ -317 +317 @@ Set up environment variables -#### Invoke the AGUI server +#### Invoke the AG-UI server @@ -319 +319 @@ Set up environment variables -To invoke the AGUI server programmatically with Python, install the required packages: +To invoke the AG-UI server programmatically with Python, install the required packages: @@ -368 +368 @@ Then use the following client code: -For building full UI applications, see [CopilotKit](https://docs.copilotkit.ai/) or the [AGUI TypeScript client SDK](https://docs.ag-ui.com/sdk/js/client/overview). +For building full UI applications, see [CopilotKit](https://docs.copilotkit.ai/) or the [AG-UI TypeScript client SDK](https://docs.ag-ui.com/sdk/js/client/overview). @@ -383 +383 @@ For building full UI applications, see [CopilotKit](https://docs.copilotkit.ai/) -For detailed Cognito setup instructions, see Set up [Cognito user pool for authentication](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-mcp.html#set-up-cognito-user-pool-for-authentication) in the MCP documentation. The setup process is identical for AGUI servers. +For detailed Cognito setup instructions, see Set up [Cognito user pool for authentication](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-mcp.html#set-up-cognito-user-pool-for-authentication) in the MCP documentation. The setup process is identical for AG-UI servers. @@ -387 +387 @@ For detailed Cognito setup instructions, see Set up [Cognito user pool for authe -**Common AGUI-specific issues** +**Common AG-UI-specific issues** @@ -394 +394 @@ Port conflicts -AGUI servers must run on port 8080 in the AgentCore Runtime environment +AG-UI servers must run on port 8080 in the AgentCore Runtime environment @@ -404 +404 @@ Event format errors -Ensure your events follow the AGUI protocol specification. See [AGUI Events Documentation](https://docs.ag-ui.com/concepts/events) +Ensure your events follow the AG-UI protocol specification. See [AG-UI Events Documentation](https://docs.ag-ui.com/concepts/events)