AWS bedrock-agentcore documentation change
Summary
Formatting and structural changes to documentation including adding example sections, restructuring command examples with numbered lists, updating typography (apostrophes and spacing), and reorganizing interactive sections.
Security assessment
The changes are purely documentation formatting and structural improvements. No security vulnerabilities, weaknesses, or incidents are mentioned. The typography changes (like apostrophe updates) and restructuring of command examples don't indicate any security implications. The OAuth section only has typographical changes without modifying security guidance.
Diff
diff --git a/bedrock-agentcore/latest/devguide/runtime-get-started-cli-typescript.md b/bedrock-agentcore/latest/devguide/runtime-get-started-cli-typescript.md index eb005a67e..939d0016b 100644 --- a//bedrock-agentcore/latest/devguide/runtime-get-started-cli-typescript.md +++ b//bedrock-agentcore/latest/devguide/runtime-get-started-cli-typescript.md @@ -76,0 +77,2 @@ To deploy a TypeScript agent, use container-based deployment. Create a project w +###### Example + @@ -79,0 +82 @@ AgentCore CLI + 1. agentcore create --name MyTsAgent --no-agent @@ -81 +83,0 @@ AgentCore CLI - agentcore create --name MyTsAgent --no-agent @@ -83 +84,0 @@ AgentCore CLI -Interactive @@ -86 +87,2 @@ Interactive -Run `agentcore create` without flags to launch the interactive wizard. Select "No" when asked to add an agent — you will add a TypeScript container agent in the next step: +Interactive + @@ -87,0 +90 @@ Run `agentcore create` without flags to launch the interactive wizard. Select "N + 1. Run `agentcore create` without flags to launch the interactive wizard. Select "No" when asked to add an agent — you will add a TypeScript container agent in the next step: @@ -111,0 +118,2 @@ Add a TypeScript agent to your project using the bring-your-own-code (BYO) workf +###### Example + @@ -114,0 +123 @@ AgentCore CLI + 1. agentcore add agent --name TsAgent --type byo --build Container --language TypeScript --framework Strands --model-provider Bedrock --code-location app/TsAgent @@ -116 +124,0 @@ AgentCore CLI - agentcore add agent --name TsAgent --type byo --build Container --language TypeScript --framework Strands --model-provider Bedrock --code-location app/TsAgent @@ -118 +125,0 @@ AgentCore CLI -Interactive @@ -121 +128,2 @@ Interactive -Run `agentcore add agent` to launch the interactive wizard. Select **Bring my own code** as the agent type: +Interactive + @@ -122,0 +131 @@ Run `agentcore add agent` to launch the interactive wizard. Select **Bring my ow + 1. Run `agentcore add agent` to launch the interactive wizard. Select **Bring my own code** as the agent type: @@ -126 +135 @@ Run `agentcore add agent` to launch the interactive wizard. Select **Bring my ow - 1. Select **Bring my own code** as the agent type: + 2. Select **Bring my own code** as the agent type: @@ -130 +139 @@ Run `agentcore add agent` to launch the interactive wizard. Select **Bring my ow - 2. Set the code location for your agent: + 3. Set the code location for your agent: @@ -134 +143 @@ Run `agentcore add agent` to launch the interactive wizard. Select **Bring my ow - 3. Review the configuration and confirm: + 4. Review the configuration and confirm: @@ -335 +344 @@ Before deploying to AWS, test your agent locally using the development server: -AgentCore CLI +###### Example @@ -336,0 +346 @@ AgentCore CLI +AgentCore CLI @@ -339 +349 @@ AgentCore CLI - agentcore dev + 1. agentcore dev @@ -351 +358,0 @@ In a separate terminal, invoke your agent against the local dev server: -Interactive @@ -354 +360,0 @@ Interactive -Run `agentcore` to open the TUI home screen, then navigate to the dev server option: @@ -355,0 +362,4 @@ Run `agentcore` to open the TUI home screen, then navigate to the dev server opt +Interactive + + + 1. Run `agentcore` to open the TUI home screen, then navigate to the dev server option: @@ -387,0 +401,2 @@ Deploy your agent to AgentCore Runtime: +###### Example + @@ -390,0 +406 @@ AgentCore CLI + 1. agentcore deploy @@ -392 +407,0 @@ AgentCore CLI - agentcore deploy @@ -394 +408,0 @@ AgentCore CLI -Interactive @@ -397 +411,2 @@ Interactive -Run `agentcore deploy` to start deployment. The CLI shows the deployment progress as it builds and deploys your project: +Interactive + @@ -398,0 +414 @@ Run `agentcore deploy` to start deployment. The CLI shows the deployment progres + 1. Run `agentcore deploy` to start deployment. The CLI shows the deployment progress as it builds and deploys your project: @@ -432,0 +452,2 @@ To check the status of your deployed resources, run: +###### Example + @@ -435,0 +457 @@ AgentCore CLI + 1. agentcore status @@ -437 +458,0 @@ AgentCore CLI - agentcore status @@ -439 +459,0 @@ AgentCore CLI -Interactive @@ -442 +462,2 @@ Interactive -Run `agentcore` to open the TUI home screen, then select the status option to view your deployed resources dashboard: +Interactive + @@ -443,0 +465 @@ Run `agentcore` to open the TUI home screen, then select the status option to vi + 1. Run `agentcore` to open the TUI home screen, then select the status option to view your deployed resources dashboard: @@ -455 +480 @@ Test your deployed agent: -AgentCore CLI +###### Example @@ -456,0 +482 @@ AgentCore CLI +AgentCore CLI @@ -459 +485 @@ AgentCore CLI - agentcore invoke "tell me a joke" + 1. agentcore invoke "tell me a joke" @@ -466 +490,0 @@ To stream the response in real time, use the `--stream` flag: -Interactive @@ -469 +492,0 @@ Interactive -Run `agentcore` to open the TUI home screen, then select the invoke option to chat with your deployed agent: @@ -470,0 +494,4 @@ Run `agentcore` to open the TUI home screen, then select the invoke option to ch +Interactive + + + 1. Run `agentcore` to open the TUI home screen, then select the invoke option to chat with your deployed agent: @@ -520 +550 @@ If successful, you should see a response from your agent. If the call fails, che -If you plan on integrating your agent with OAuth, you can't use the AWS SDK to call `InvokeAgentRuntime`. Instead, make a HTTPS request to `InvokeAgentRuntime`. For more information, see [Authenticate and authorize with Inbound Auth and Outbound Auth](./runtime-oauth.html). +If you plan on integrating your agent with OAuth, you can’t use the AWS SDK to call `InvokeAgentRuntime` . Instead, make a HTTPS request to `InvokeAgentRuntime` . For more information, see [Authenticate and authorize with Inbound Auth and Outbound Auth](./runtime-oauth.html). @@ -528 +558 @@ Create a file named `stop-runtime-session.ts` with the following content: -###### Example +**Example** @@ -556 +585 @@ If you no longer want to host the agent in the AgentCore Runtime, remove all res -AgentCore CLI +###### Example @@ -557,0 +587 @@ AgentCore CLI +AgentCore CLI @@ -560 +590 @@ AgentCore CLI - agentcore remove all --yes + 1. agentcore remove all --yes @@ -563 +592,0 @@ AgentCore CLI -Interactive @@ -566 +594,0 @@ Interactive -Run `agentcore` to open the TUI home screen, then select the remove option to choose which resources to remove: @@ -567,0 +596,4 @@ Run `agentcore` to open the TUI home screen, then select the remove option to ch +Interactive + + + 1. Run `agentcore` to open the TUI home screen, then select the remove option to choose which resources to remove: @@ -577 +612 @@ After deployment, view your resources in the AWS Console: -Resource locations Resource | Location +Resource | Location @@ -596 +631 @@ Install Docker, Podman, or Finch. For Docker, ensure Docker Desktop is running. -Ensure a `Dockerfile` exists in your agent's code directory (for example, `app/TsAgent/Dockerfile`). The container build requires a Dockerfile in the directory specified by `codeLocation` in `agentcore/agentcore.json`. +Ensure a `Dockerfile` exists in your agent’s code directory (for example, `app/TsAgent/Dockerfile` ). The container build requires a Dockerfile in the directory specified by `codeLocation` in `agentcore/agentcore.json`. @@ -652 +687 @@ Use `lsof -ti:8080` to get a list of process using port 8080. -Use `kill -9 `PID`` to stop the process. Replace `PID` with the process ID. +Use `kill -9 PID` to stop the process. Replace `PID` with the process ID.