AWS bedrock-agentcore documentation change
Summary
Updated tool specification syntax, added KMS encryption option, trace sources, asynchronous handling, and simplified JSON path references
Security assessment
Added --kms-key option for encrypting tool description recommendations, improving data security. Changed tool specification format but no vulnerability fixes indicated.
Diff
diff --git a/bedrock-agentcore/latest/devguide/recommendations-tool-description.md b/bedrock-agentcore/latest/devguide/recommendations-tool-description.md index ca372a491..de5e26cb1 100644 --- a//bedrock-agentcore/latest/devguide/recommendations-tool-description.md +++ b//bedrock-agentcore/latest/devguide/recommendations-tool-description.md @@ -23,0 +24,4 @@ AgentCore CLI +###### Note + +Unlike system prompt recommendations, which require exactly one `-e/--evaluator`, tool description runs omit `-e/--evaluator` entirely. + @@ -31 +35,2 @@ Inline tool descriptions with CloudWatch traces: - --tools "lookup_order:Look up an order by ID, initiate_return:Initiate a return for an order" \ + --tools "lookup_order:Look up an order by ID" \ + --tools "initiate_return:Initiate a return for an order" \ @@ -41 +46,2 @@ Inline tool descriptions with a spans file: - --tools "lookup_order:Look up an order by ID, initiate_return:Initiate a return for an order" \ + --tools "lookup_order:Look up an order by ID" \ + --tools "initiate_return:Initiate a return for an order" \ @@ -51 +57,2 @@ Inline tool descriptions with specific session IDs: - --tools "lookup_order:Look up an order by ID, initiate_return:Initiate a return for an order" \ + --tools "lookup_order:Look up an order by ID" \ + --tools "initiate_return:Initiate a return for an order" \ @@ -63,2 +70,2 @@ Configuration bundle with CloudWatch traces: - --tool-desc-json-path "lookup_order:$.configuration.tools.lookup_order.description" \ - --tool-desc-json-path "initiate_return:$.configuration.tools.initiate_return.description" \ + --tool-desc-json-path "lookup_order:lookup_order" \ + --tool-desc-json-path "initiate_return:initiate_return" \ @@ -76,2 +83,2 @@ Configuration bundle with a spans file: - --tool-desc-json-path "lookup_order:$.configuration.tools.lookup_order.description" \ - --tool-desc-json-path "initiate_return:$.configuration.tools.initiate_return.description" \ + --tool-desc-json-path "lookup_order:lookup_order" \ + --tool-desc-json-path "initiate_return:initiate_return" \ @@ -79,0 +87,19 @@ Configuration bundle with a spans file: +Besides `--lookback`, `--spans-file`, and `--session-id`, `agentcore run recommendation` accepts two more trace sources: `--from-insights <id>` (use a local insights run as the trace source; the CLI resolves the batch evaluation ARN) and `--batch-evaluation-arn <arn>` (use a batch evaluation ARN directly). For an overview of all trace sources, see [Trace sources for recommendations](./optimization-recommendations.html#recommendations-trace-sources). You can also add `--kms-key <arn>` to encrypt the recommendation results with a customer managed KMS key. + +To block until the recommendation reaches a terminal state, add `--wait`: + + + agentcore run recommendation \ + --type tool-description \ + --run my-tool-rec \ + --runtime MyAgent \ + --tools "lookup_order:Look up an order by ID" \ + --tools "initiate_return:Initiate a return for an order" \ + --lookback 7 \ + --wait + +Retrieve the completed result, including the optimized tool descriptions, with `agentcore view recommendation`: + + + agentcore view recommendation <recommendation-id> --json + @@ -262,2 +288,2 @@ Mode | CLI flags | API field -Inline text | `--tools "name:description, name:description"` | `toolDescription.toolDescriptionText.tools`. List of objects with `toolName` and `toolDescription` -Configuration bundle | `--bundle-name <bundle-name>` \+ `--bundle-version <bundle-version>` \+ `--tool-desc-json-path "name:jsonpath"` (repeat for each tool) | `toolDescription.configurationBundle` with `bundleArn`, `versionId`, and `tools` list containing `toolName` and `toolDescriptionJsonPath` +Inline text | `--tools "name:description"` (repeat for each tool) | `toolDescription.toolDescriptionText.tools`. List of objects with `toolName` and `toolDescription` +Configuration bundle | `--bundle-name <bundle-name>` \+ `--bundle-version <bundle-version>` \+ `--tool-desc-json-path "name:field"` (repeat for each tool) | `toolDescription.configurationBundle` with `bundleArn`, `versionId`, and `tools` list containing `toolName` and `toolDescriptionJsonPath`