@aws/agentcore 1.0.0-preview.15 → 1.0.0-preview.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +132 -13
- package/dist/assets/__tests__/__snapshots__/assets.snapshot.test.ts.snap +74 -12
- package/dist/assets/agents/AGENTS.md +74 -12
- package/dist/cli/index.mjs +490 -490
- package/dist/lib/errors/types.d.ts +27 -3
- package/dist/lib/errors/types.d.ts.map +1 -1
- package/dist/lib/errors/types.js +41 -7
- package/dist/lib/errors/types.js.map +1 -1
- package/dist/lib/result.d.ts +7 -3
- package/dist/lib/result.d.ts.map +1 -1
- package/dist/lib/result.js +14 -0
- package/dist/lib/result.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -91,10 +91,10 @@ agentcore invoke
|
|
|
91
91
|
|
|
92
92
|
### Resource Management
|
|
93
93
|
|
|
94
|
-
| Command | Description
|
|
95
|
-
| -------- |
|
|
96
|
-
| `add` | Add agents, memory, credentials, evaluators,
|
|
97
|
-
| `remove` | Remove resources from project
|
|
94
|
+
| Command | Description |
|
|
95
|
+
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
96
|
+
| `add` | Add agents, memory, credentials, gateways and gateway-targets, evaluators, online evals, online insights, knowledge bases, config bundles, datasets, harnesses, policy engines and policies, payment managers and payment connectors, runtime endpoints |
|
|
97
|
+
| `remove` | Remove any of the above resources from the project |
|
|
98
98
|
|
|
99
99
|
> **Note**: Run `agentcore deploy` after `add` or `remove` to update resources in AWS.
|
|
100
100
|
|
|
@@ -145,6 +145,94 @@ agentcore invoke
|
|
|
145
145
|
| `promote ab-test` | Apply the winning variant to `agentcore.json` |
|
|
146
146
|
| `archive ab-test` | Delete the test on the service and clear local history |
|
|
147
147
|
|
|
148
|
+
### Knowledge Bases
|
|
149
|
+
|
|
150
|
+
| Command | Description |
|
|
151
|
+
| -------------------- | ------------------------------------------------------- |
|
|
152
|
+
| `add knowledge-base` | Add a managed Bedrock Knowledge Base wired to a gateway |
|
|
153
|
+
|
|
154
|
+
> See [Knowledge Bases](docs/knowledge-bases.md) for ingestion, vectorization, and retrieval setup.
|
|
155
|
+
|
|
156
|
+
### Insights — `[preview]`
|
|
157
|
+
|
|
158
|
+
Failure-pattern analysis across agent sessions. Insights configs run continuously alongside online evals and surface
|
|
159
|
+
clusters of bad outcomes.
|
|
160
|
+
|
|
161
|
+
| Command | Description |
|
|
162
|
+
| ------------------------ | ----------------------------------------------------------- |
|
|
163
|
+
| `add online-insights` | Add a continuous insights config bound to a runtime |
|
|
164
|
+
| `run insights` | Run on-demand failure analysis across recent sessions |
|
|
165
|
+
| `view insights` | List insights jobs or view one in detail |
|
|
166
|
+
| `pause online-insights` | Pause a deployed online insights config |
|
|
167
|
+
| `resume online-insights` | Resume a paused online insights config |
|
|
168
|
+
| `archive insights` | Delete an insights job on the service + clear local history |
|
|
169
|
+
|
|
170
|
+
### Harness — `[preview]`
|
|
171
|
+
|
|
172
|
+
> Harness commands are only available in the preview release of the CLI. Install it with:
|
|
173
|
+
>
|
|
174
|
+
> ```bash
|
|
175
|
+
> npm install -g @aws/agentcore@preview
|
|
176
|
+
> ```
|
|
177
|
+
|
|
178
|
+
A harness bundles a runtime, model, tools, skills, memory, and observability into one declarative config. Use it when
|
|
179
|
+
you want infra without writing agent code.
|
|
180
|
+
|
|
181
|
+
| Command | Description |
|
|
182
|
+
| ---------------- | --------------------------------------------------------------------------- |
|
|
183
|
+
| `add harness` | Add a harness resource (runtime + model + memory) |
|
|
184
|
+
| `add tool` | Add a tool to a harness (`--harness <name> --type <type> --name <name>`) |
|
|
185
|
+
| `add skill` | Add a skill to a harness (`--harness <name>` + `--path` / `--s3` / `--git`) |
|
|
186
|
+
| `export harness` | Export a harness config to a deployable Strands Python agent under `app/` |
|
|
187
|
+
|
|
188
|
+
> After `export harness`, **read `app/<agentName>/EXPORT_NOTES.md`** before running `deploy` — it lists any manual
|
|
189
|
+
> follow-up the exporter could not automate.
|
|
190
|
+
|
|
191
|
+
### Policies & Guardrails
|
|
192
|
+
|
|
193
|
+
Policy engines apply Cedar-based pre/post-call policies to agent invocations — including Bedrock content filters
|
|
194
|
+
(`VIOLENCE`, `HATE`, `SEXUAL`, `MISCONDUCT`, `INSULTS`), prompt-attack detection, and sensitive-information redaction.
|
|
195
|
+
|
|
196
|
+
| Command | Description |
|
|
197
|
+
| ------------------- | -------------------------------------------------------------------- |
|
|
198
|
+
| `add policy-engine` | Add a Cedar policy engine to the project |
|
|
199
|
+
| `add policy` | Add a policy to a policy engine (form-based guardrails or raw Cedar) |
|
|
200
|
+
|
|
201
|
+
### Payments
|
|
202
|
+
|
|
203
|
+
Pay-per-call agent transactions via the [x402 protocol](https://www.x402.org/). When a tool call returns
|
|
204
|
+
`402 Payment Required`, the payments system signs and submits payment then retries automatically.
|
|
205
|
+
|
|
206
|
+
| Command | Description |
|
|
207
|
+
| ----------------------- | ---------------------------------------------------------------------------- |
|
|
208
|
+
| `add payment-manager` | Add a payment manager (orchestrates payment sessions for the agent) |
|
|
209
|
+
| `add payment-connector` | Add a payment connector with provider credentials (CoinbaseCDP, StripePrivy) |
|
|
210
|
+
|
|
211
|
+
> See [Payments](docs/payments.md) for the full setup including instrument creation and tool allowlists.
|
|
212
|
+
|
|
213
|
+
### Datasets
|
|
214
|
+
|
|
215
|
+
Curated session datasets for batch evaluation and recommendation runs.
|
|
216
|
+
|
|
217
|
+
| Command | Description |
|
|
218
|
+
| ------------------------- | ------------------------------------------------------------------------- |
|
|
219
|
+
| `add dataset` | Add a dataset resource (session list, ground-truth file, or trace filter) |
|
|
220
|
+
| `dataset download` | Download a dataset version locally |
|
|
221
|
+
| `dataset publish-version` | Publish a new dataset version |
|
|
222
|
+
| `dataset remove-version` | Remove a dataset version |
|
|
223
|
+
|
|
224
|
+
### Web Search Gateway Targets
|
|
225
|
+
|
|
226
|
+
Add a managed web-search target to a gateway:
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
agentcore add gateway-target --type connector --connector web-search \
|
|
230
|
+
--gateway <gateway-name> --name <target-name>
|
|
231
|
+
# Optional: --exclude-domains "example.com,foo.org"
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
See [Gateway](docs/gateway.md) for full target setup including Lambda, MCP, OpenAPI, Smithy, and API Gateway.
|
|
235
|
+
|
|
148
236
|
### Utilities
|
|
149
237
|
|
|
150
238
|
| Command | Description |
|
|
@@ -181,31 +269,62 @@ my-project/
|
|
|
181
269
|
|
|
182
270
|
Projects use JSON schema files in the `agentcore/` directory:
|
|
183
271
|
|
|
184
|
-
- `agentcore.json` -
|
|
272
|
+
- `agentcore.json` - Project resources (agents, memory, credentials, gateways, evaluators, online evals/insights,
|
|
273
|
+
knowledge bases, harnesses, policy engines and policies, payment managers and connectors, config bundles, datasets,
|
|
274
|
+
runtime endpoints)
|
|
185
275
|
- `deployed-state.json` - Runtime state in agentcore/.cli/ (auto-managed)
|
|
186
276
|
- `aws-targets.json` - Deployment targets (account, region)
|
|
187
277
|
|
|
188
278
|
## Capabilities
|
|
189
279
|
|
|
190
280
|
- **Runtime** - Managed execution environment for deployed agents
|
|
191
|
-
- **Memory** - Semantic, summarization, and
|
|
192
|
-
- **Credentials** - Secure API key management via Secrets Manager
|
|
193
|
-
- **
|
|
281
|
+
- **Memory** - Semantic, summarization, user-preference, and episodic strategies
|
|
282
|
+
- **Credentials** - Secure API key + OAuth credential management via Secrets Manager
|
|
283
|
+
- **Gateways** - MCP gateways with Lambda / MCP server / OpenAPI / Smithy / API Gateway / **web-search** /
|
|
284
|
+
**knowledge-base** targets
|
|
285
|
+
- **Evaluations** - LLM-as-a-Judge for on-demand, batch, and continuous agent quality monitoring
|
|
286
|
+
- **Recommendations** - Auto-optimize system prompts and tool descriptions from real session traces
|
|
287
|
+
- **A/B Tests** - Traffic-split between config-bundle or target-based variants and promote the winner
|
|
288
|
+
- **Insights** _[preview]_ - Failure-pattern analysis and clustering across agent sessions
|
|
289
|
+
- **Knowledge Bases** - Managed Bedrock Knowledge Bases auto-wired to gateways
|
|
290
|
+
- **Harness** - Declarative agent: bundle runtime + tools + skills + memory + observability without writing agent code
|
|
291
|
+
- **Policies & Guardrails** - Cedar pre/post-call policies including Bedrock content filters, prompt-attack detection,
|
|
292
|
+
and sensitive-information redaction
|
|
293
|
+
- **Payments** - x402-protocol microtransactions for pay-per-call tools and APIs
|
|
294
|
+
- **Config Bundles** - Versioned runtime configurations as a separately-deployable resource
|
|
194
295
|
|
|
195
296
|
## Documentation
|
|
196
297
|
|
|
298
|
+
**Reference**
|
|
299
|
+
|
|
197
300
|
- [CLI Commands Reference](docs/commands.md) - Full command reference for scripting and CI/CD
|
|
198
301
|
- [Configuration](docs/configuration.md) - Schema reference for config files
|
|
302
|
+
- [Frameworks](docs/frameworks.md) - Supported frameworks and model providers
|
|
303
|
+
- [PERMISSIONS](docs/PERMISSIONS.md) - IAM permissions required to deploy
|
|
304
|
+
|
|
305
|
+
**Resources & features**
|
|
306
|
+
|
|
307
|
+
- [Memory](docs/memory.md) - Memory strategies and sharing
|
|
308
|
+
- [Gateway](docs/gateway.md) - Gateway setup, targets, and authentication
|
|
309
|
+
- [Knowledge Bases](docs/knowledge-bases.md) - Managed Bedrock Knowledge Bases wired to gateways
|
|
310
|
+
- [Payments](docs/payments.md) - x402-protocol microtransactions for paid tools/APIs
|
|
311
|
+
- [Config Bundles](docs/config-bundles.md) - Versioned runtime configurations
|
|
312
|
+
- [Container Builds](docs/container-builds.md) - Container build types and Dockerfile setup
|
|
313
|
+
|
|
314
|
+
**Evaluation & quality**
|
|
315
|
+
|
|
199
316
|
- [Evaluations](docs/evals.md) - Evaluators, on-demand evals, and online monitoring
|
|
200
317
|
- [Batch Evaluation](docs/batch-evaluation.md) - Run evaluators across sessions at scale
|
|
201
318
|
- [Recommendations](docs/recommendations.md) - Optimize prompts and tool descriptions
|
|
202
319
|
- [A/B Tests](docs/ab-tests.md) - Split traffic between variants and promote the winner
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
- [Knowledge Bases](docs/knowledge-bases.md) - Managed Bedrock Knowledge Bases wired to gateways
|
|
207
|
-
- [Memory](docs/memory.md) - Memory strategies and sharing
|
|
320
|
+
|
|
321
|
+
**Operations**
|
|
322
|
+
|
|
208
323
|
- [Local Development](docs/local-development.md) - Dev server and debugging
|
|
324
|
+
- [Transaction Search](docs/transaction_search.md) - Trace + log search across agent invocations
|
|
325
|
+
- [Telemetry](docs/telemetry.md) - CLI usage telemetry — what's collected and how to opt out
|
|
326
|
+
- [TUI Harness](docs/tui-harness.md) - Programmatic TUI driver for testing
|
|
327
|
+
- [Testing](docs/TESTING.md) - Unit, integration, and e2e test infrastructure
|
|
209
328
|
- [Feedback](docs/feedback.md) - Submit feedback from your terminal
|
|
210
329
|
|
|
211
330
|
## Examples
|
|
@@ -7148,13 +7148,21 @@ file maps to a JSON config file and includes validation constraints as comments
|
|
|
7148
7148
|
|
|
7149
7149
|
### Key Types
|
|
7150
7150
|
|
|
7151
|
-
- **AgentCoreProjectSpec**: Root config with \`runtimes\`, \`memories\`, \`credentials\`, \`agentCoreGateways\`, \`evaluators\`, \`onlineEvalConfigs\`, \`policyEngines\` arrays
|
|
7151
|
+
- **AgentCoreProjectSpec**: Root config with \`runtimes\`, \`memories\`, \`credentials\`, \`agentCoreGateways\`, \`evaluators\`, \`onlineEvalConfigs\`, \`onlineInsightsConfigs\`, \`knowledgeBases\`, \`harnesses\`, \`policyEngines\`, \`policies\`, \`payments\` (managers + connectors), \`configBundles\`, \`datasets\`, \`runtimeEndpoints\` arrays
|
|
7152
7152
|
- **AgentEnvSpec**: Agent configuration (build type, entrypoint, code location, runtime version, network mode)
|
|
7153
7153
|
- **Memory**: Memory resource with strategies (SEMANTIC, SUMMARIZATION, USER_PREFERENCE, EPISODIC) and expiry
|
|
7154
7154
|
- **Credential**: API key or OAuth credential provider
|
|
7155
|
-
- **AgentCoreGateway**: MCP gateway with targets (Lambda, MCP server, OpenAPI, Smithy, API Gateway)
|
|
7155
|
+
- **AgentCoreGateway**: MCP gateway with targets (Lambda, MCP server, OpenAPI, Smithy, API Gateway, web-search, knowledge-base)
|
|
7156
7156
|
- **Evaluator**: LLM-as-a-Judge or code-based evaluator
|
|
7157
7157
|
- **OnlineEvalConfig**: Continuous evaluation pipeline bound to an agent
|
|
7158
|
+
- **OnlineInsightsConfig** _[preview]_: Continuous failure-pattern analysis bound to an agent
|
|
7159
|
+
- **KnowledgeBase**: Managed Bedrock Knowledge Base auto-wired to a gateway
|
|
7160
|
+
- **Harness**: Declarative agent — runtime + tools + skills + memory + observability without writing agent code
|
|
7161
|
+
- **PolicyEngine** + **Policy**: Cedar policy engine with form-based guardrails (Bedrock content filters, prompt-attack, sensitive-info) or raw Cedar policies
|
|
7162
|
+
- **PaymentManager** + **PaymentConnector**: x402-protocol payment orchestration with provider credentials (CoinbaseCDP, StripePrivy)
|
|
7163
|
+
- **ConfigBundle**: Versioned runtime configuration as a separately-deployable resource
|
|
7164
|
+
- **Dataset**: Curated session dataset for batch evaluation and recommendation runs
|
|
7165
|
+
- **RuntimeEndpoint**: Named endpoint (e.g. \`PROMPT_V1\`) targeting a specific runtime version
|
|
7158
7166
|
|
|
7159
7167
|
### Common Enum Values
|
|
7160
7168
|
|
|
@@ -7162,8 +7170,11 @@ file maps to a JSON config file and includes validation constraints as comments
|
|
|
7162
7170
|
- **NetworkMode**: \`'PUBLIC'\` | \`'VPC'\`
|
|
7163
7171
|
- **RuntimeVersion**: \`'PYTHON_3_10'\` | \`'PYTHON_3_11'\` | \`'PYTHON_3_12'\` | \`'PYTHON_3_13'\` | \`'PYTHON_3_14'\` | \`'NODE_18'\` | \`'NODE_20'\` | \`'NODE_22'\`
|
|
7164
7172
|
- **MemoryStrategyType**: \`'SEMANTIC'\` | \`'SUMMARIZATION'\` | \`'USER_PREFERENCE'\` | \`'EPISODIC'\`
|
|
7165
|
-
- **GatewayTargetType**: \`'lambda'\` | \`'mcpServer'\` | \`'openApiSchema'\` | \`'smithyModel'\` | \`'apiGateway'\` | \`'lambdaFunctionArn'\`
|
|
7173
|
+
- **GatewayTargetType**: \`'lambda'\` | \`'mcpServer'\` | \`'openApiSchema'\` | \`'smithyModel'\` | \`'apiGateway'\` | \`'lambdaFunctionArn'\` | \`'connector'\` (web-search, bedrock-knowledge-bases, bedrock-agentic-retrieve)
|
|
7166
7174
|
- **ModelProvider**: \`'Bedrock'\` | \`'Gemini'\` | \`'OpenAI'\` | \`'Anthropic'\`
|
|
7175
|
+
- **PaymentProvider**: \`'CoinbaseCDP'\` | \`'StripePrivy'\`
|
|
7176
|
+
- **PolicyEnforcementMode**: \`'ACTIVE'\` | \`'PASSIVE'\`
|
|
7177
|
+
- **GuardrailContentFilter**: \`'VIOLENCE'\` | \`'HATE'\` | \`'SEXUAL'\` | \`'MISCONDUCT'\` | \`'INSULTS'\`
|
|
7167
7178
|
|
|
7168
7179
|
### Build Types
|
|
7169
7180
|
|
|
@@ -7229,22 +7240,73 @@ cat app/<agentName>/EXPORT_NOTES.md # read this before touching anyt
|
|
|
7229
7240
|
|
|
7230
7241
|
## CLI Commands
|
|
7231
7242
|
|
|
7243
|
+
Run \`agentcore --help\` or \`agentcore <command> --help\` for full flags. Commonly used:
|
|
7244
|
+
|
|
7245
|
+
**Project lifecycle**
|
|
7246
|
+
|
|
7232
7247
|
| Command | Description |
|
|
7233
7248
|
| --- | --- |
|
|
7234
7249
|
| \`agentcore create\` | Create a new project |
|
|
7235
|
-
| \`agentcore add <resource>\` | Add agent, memory, credential, gateway, evaluator, policy |
|
|
7236
|
-
| \`agentcore remove <resource>\` | Remove a resource |
|
|
7237
|
-
| \`agentcore export harness\` | Export a harness to a Strands runtime agent |
|
|
7238
7250
|
| \`agentcore dev\` | Run agent locally with hot-reload |
|
|
7239
7251
|
| \`agentcore deploy\` | Deploy to AWS |
|
|
7240
|
-
| \`agentcore status\` | Show deployment status |
|
|
7241
7252
|
| \`agentcore invoke\` | Invoke agent (local or deployed) |
|
|
7242
|
-
| \`agentcore
|
|
7243
|
-
| \`agentcore traces\` | View agent traces |
|
|
7244
|
-
| \`agentcore eval\` | Run evaluations against an agent |
|
|
7245
|
-
| \`agentcore package\` | Package agent artifacts |
|
|
7253
|
+
| \`agentcore status\` | Show deployment status |
|
|
7246
7254
|
| \`agentcore validate\` | Validate configuration |
|
|
7247
|
-
| \`agentcore
|
|
7255
|
+
| \`agentcore package\` | Package agent artifacts |
|
|
7256
|
+
| \`agentcore import\` | Import resources from a Bedrock AgentCore Starter Toolkit project |
|
|
7257
|
+
|
|
7258
|
+
**Resources**
|
|
7259
|
+
|
|
7260
|
+
| Command | Description |
|
|
7261
|
+
| --- | --- |
|
|
7262
|
+
| \`agentcore add <resource>\` | Add agent, memory, credential, gateway, gateway-target, evaluator, online-eval, online-insights, knowledge-base, harness, policy-engine, policy, payment-manager, payment-connector, config-bundle, dataset, runtime-endpoint |
|
|
7263
|
+
| \`agentcore remove <resource>\` | Remove any resource |
|
|
7264
|
+
| \`agentcore export harness\` | Export a harness to a Strands runtime agent under \`app/<agentName>/\` |
|
|
7265
|
+
|
|
7266
|
+
**Jobs (run, view, archive, lifecycle)**
|
|
7267
|
+
|
|
7268
|
+
| Command | Description |
|
|
7269
|
+
| --- | --- |
|
|
7270
|
+
| \`agentcore run eval\` | Run on-demand evaluation against agent traces |
|
|
7271
|
+
| \`agentcore run batch-evaluation\` | Run evaluators across all sessions at scale |
|
|
7272
|
+
| \`agentcore run recommendation\` | Optimize prompts or tool descriptions from real traces |
|
|
7273
|
+
| \`agentcore run insights\` _[preview]_ | Run failure-pattern analysis across sessions |
|
|
7274
|
+
| \`agentcore run ab-test\` | Start an A/B test (config-bundle or target-based) |
|
|
7275
|
+
| \`agentcore run ingest\` | Start a fresh ingestion job for every data source on a deployed knowledge base |
|
|
7276
|
+
| \`agentcore view <type>\` | List or view jobs (recommendation, batch-evaluation, ab-test, insights) |
|
|
7277
|
+
| \`agentcore archive <type>\` | Delete a job on the service + clear local history |
|
|
7278
|
+
| \`agentcore stop <type>\` | Stop a running batch-evaluation or ab-test |
|
|
7279
|
+
| \`agentcore promote ab-test\` | Apply the winning variant to \`agentcore.json\` |
|
|
7280
|
+
| \`agentcore pause <type>\` / \`agentcore resume <type>\` | Pause/resume a deployed online-eval, online-insights, or ab-test |
|
|
7281
|
+
|
|
7282
|
+
**Config bundles & datasets**
|
|
7283
|
+
|
|
7284
|
+
| Command | Description |
|
|
7285
|
+
| --- | --- |
|
|
7286
|
+
| \`agentcore config-bundle versions\` (alias \`cb versions\`) | List version history for a bundle |
|
|
7287
|
+
| \`agentcore config-bundle diff\` | Diff two versions of a bundle |
|
|
7288
|
+
| \`agentcore config-bundle create-branch\` | Create a new branch on an existing bundle |
|
|
7289
|
+
| \`agentcore dataset download\` | Download a dataset version locally |
|
|
7290
|
+
| \`agentcore dataset publish-version\` | Publish a new dataset version |
|
|
7291
|
+
| \`agentcore dataset remove-version\` | Remove a dataset version |
|
|
7292
|
+
|
|
7293
|
+
**Observability & history**
|
|
7294
|
+
|
|
7295
|
+
| Command | Description |
|
|
7296
|
+
| --- | --- |
|
|
7297
|
+
| \`agentcore logs\` | Stream/search agent runtime logs |
|
|
7298
|
+
| \`agentcore logs evals\` | Stream/search online-eval logs |
|
|
7299
|
+
| \`agentcore traces list\` / \`agentcore traces get\` | List recent traces or download one to JSON |
|
|
7300
|
+
| \`agentcore evals history\` | View past on-demand eval results |
|
|
7301
|
+
|
|
7302
|
+
**Utilities**
|
|
7303
|
+
|
|
7304
|
+
| Command | Description |
|
|
7305
|
+
| --- | --- |
|
|
7306
|
+
| \`agentcore fetch access\` | Fetch access info for deployed gateway or agent |
|
|
7307
|
+
| \`agentcore feedback\` | Send feedback (with optional screenshot) to the AgentCore team |
|
|
7308
|
+
| \`agentcore update\` | Check for and install CLI updates |
|
|
7309
|
+
| \`agentcore telemetry\` | View or change telemetry preferences |
|
|
7248
7310
|
"
|
|
7249
7311
|
`;
|
|
7250
7312
|
|
|
@@ -56,13 +56,21 @@ file maps to a JSON config file and includes validation constraints as comments
|
|
|
56
56
|
|
|
57
57
|
### Key Types
|
|
58
58
|
|
|
59
|
-
- **AgentCoreProjectSpec**: Root config with `runtimes`, `memories`, `credentials`, `agentCoreGateways`, `evaluators`, `onlineEvalConfigs`, `policyEngines` arrays
|
|
59
|
+
- **AgentCoreProjectSpec**: Root config with `runtimes`, `memories`, `credentials`, `agentCoreGateways`, `evaluators`, `onlineEvalConfigs`, `onlineInsightsConfigs`, `knowledgeBases`, `harnesses`, `policyEngines`, `policies`, `payments` (managers + connectors), `configBundles`, `datasets`, `runtimeEndpoints` arrays
|
|
60
60
|
- **AgentEnvSpec**: Agent configuration (build type, entrypoint, code location, runtime version, network mode)
|
|
61
61
|
- **Memory**: Memory resource with strategies (SEMANTIC, SUMMARIZATION, USER_PREFERENCE, EPISODIC) and expiry
|
|
62
62
|
- **Credential**: API key or OAuth credential provider
|
|
63
|
-
- **AgentCoreGateway**: MCP gateway with targets (Lambda, MCP server, OpenAPI, Smithy, API Gateway)
|
|
63
|
+
- **AgentCoreGateway**: MCP gateway with targets (Lambda, MCP server, OpenAPI, Smithy, API Gateway, web-search, knowledge-base)
|
|
64
64
|
- **Evaluator**: LLM-as-a-Judge or code-based evaluator
|
|
65
65
|
- **OnlineEvalConfig**: Continuous evaluation pipeline bound to an agent
|
|
66
|
+
- **OnlineInsightsConfig** _[preview]_: Continuous failure-pattern analysis bound to an agent
|
|
67
|
+
- **KnowledgeBase**: Managed Bedrock Knowledge Base auto-wired to a gateway
|
|
68
|
+
- **Harness**: Declarative agent — runtime + tools + skills + memory + observability without writing agent code
|
|
69
|
+
- **PolicyEngine** + **Policy**: Cedar policy engine with form-based guardrails (Bedrock content filters, prompt-attack, sensitive-info) or raw Cedar policies
|
|
70
|
+
- **PaymentManager** + **PaymentConnector**: x402-protocol payment orchestration with provider credentials (CoinbaseCDP, StripePrivy)
|
|
71
|
+
- **ConfigBundle**: Versioned runtime configuration as a separately-deployable resource
|
|
72
|
+
- **Dataset**: Curated session dataset for batch evaluation and recommendation runs
|
|
73
|
+
- **RuntimeEndpoint**: Named endpoint (e.g. `PROMPT_V1`) targeting a specific runtime version
|
|
66
74
|
|
|
67
75
|
### Common Enum Values
|
|
68
76
|
|
|
@@ -70,8 +78,11 @@ file maps to a JSON config file and includes validation constraints as comments
|
|
|
70
78
|
- **NetworkMode**: `'PUBLIC'` | `'VPC'`
|
|
71
79
|
- **RuntimeVersion**: `'PYTHON_3_10'` | `'PYTHON_3_11'` | `'PYTHON_3_12'` | `'PYTHON_3_13'` | `'PYTHON_3_14'` | `'NODE_18'` | `'NODE_20'` | `'NODE_22'`
|
|
72
80
|
- **MemoryStrategyType**: `'SEMANTIC'` | `'SUMMARIZATION'` | `'USER_PREFERENCE'` | `'EPISODIC'`
|
|
73
|
-
- **GatewayTargetType**: `'lambda'` | `'mcpServer'` | `'openApiSchema'` | `'smithyModel'` | `'apiGateway'` | `'lambdaFunctionArn'`
|
|
81
|
+
- **GatewayTargetType**: `'lambda'` | `'mcpServer'` | `'openApiSchema'` | `'smithyModel'` | `'apiGateway'` | `'lambdaFunctionArn'` | `'connector'` (web-search, bedrock-knowledge-bases, bedrock-agentic-retrieve)
|
|
74
82
|
- **ModelProvider**: `'Bedrock'` | `'Gemini'` | `'OpenAI'` | `'Anthropic'`
|
|
83
|
+
- **PaymentProvider**: `'CoinbaseCDP'` | `'StripePrivy'`
|
|
84
|
+
- **PolicyEnforcementMode**: `'ACTIVE'` | `'PASSIVE'`
|
|
85
|
+
- **GuardrailContentFilter**: `'VIOLENCE'` | `'HATE'` | `'SEXUAL'` | `'MISCONDUCT'` | `'INSULTS'`
|
|
75
86
|
|
|
76
87
|
### Build Types
|
|
77
88
|
|
|
@@ -137,19 +148,70 @@ cat app/<agentName>/EXPORT_NOTES.md # read this before touching anyt
|
|
|
137
148
|
|
|
138
149
|
## CLI Commands
|
|
139
150
|
|
|
151
|
+
Run `agentcore --help` or `agentcore <command> --help` for full flags. Commonly used:
|
|
152
|
+
|
|
153
|
+
**Project lifecycle**
|
|
154
|
+
|
|
140
155
|
| Command | Description |
|
|
141
156
|
| --- | --- |
|
|
142
157
|
| `agentcore create` | Create a new project |
|
|
143
|
-
| `agentcore add <resource>` | Add agent, memory, credential, gateway, evaluator, policy |
|
|
144
|
-
| `agentcore remove <resource>` | Remove a resource |
|
|
145
|
-
| `agentcore export harness` | Export a harness to a Strands runtime agent |
|
|
146
158
|
| `agentcore dev` | Run agent locally with hot-reload |
|
|
147
159
|
| `agentcore deploy` | Deploy to AWS |
|
|
148
|
-
| `agentcore status` | Show deployment status |
|
|
149
160
|
| `agentcore invoke` | Invoke agent (local or deployed) |
|
|
150
|
-
| `agentcore
|
|
151
|
-
| `agentcore traces` | View agent traces |
|
|
152
|
-
| `agentcore eval` | Run evaluations against an agent |
|
|
153
|
-
| `agentcore package` | Package agent artifacts |
|
|
161
|
+
| `agentcore status` | Show deployment status |
|
|
154
162
|
| `agentcore validate` | Validate configuration |
|
|
155
|
-
| `agentcore
|
|
163
|
+
| `agentcore package` | Package agent artifacts |
|
|
164
|
+
| `agentcore import` | Import resources from a Bedrock AgentCore Starter Toolkit project |
|
|
165
|
+
|
|
166
|
+
**Resources**
|
|
167
|
+
|
|
168
|
+
| Command | Description |
|
|
169
|
+
| --- | --- |
|
|
170
|
+
| `agentcore add <resource>` | Add agent, memory, credential, gateway, gateway-target, evaluator, online-eval, online-insights, knowledge-base, harness, policy-engine, policy, payment-manager, payment-connector, config-bundle, dataset, runtime-endpoint |
|
|
171
|
+
| `agentcore remove <resource>` | Remove any resource |
|
|
172
|
+
| `agentcore export harness` | Export a harness to a Strands runtime agent under `app/<agentName>/` |
|
|
173
|
+
|
|
174
|
+
**Jobs (run, view, archive, lifecycle)**
|
|
175
|
+
|
|
176
|
+
| Command | Description |
|
|
177
|
+
| --- | --- |
|
|
178
|
+
| `agentcore run eval` | Run on-demand evaluation against agent traces |
|
|
179
|
+
| `agentcore run batch-evaluation` | Run evaluators across all sessions at scale |
|
|
180
|
+
| `agentcore run recommendation` | Optimize prompts or tool descriptions from real traces |
|
|
181
|
+
| `agentcore run insights` _[preview]_ | Run failure-pattern analysis across sessions |
|
|
182
|
+
| `agentcore run ab-test` | Start an A/B test (config-bundle or target-based) |
|
|
183
|
+
| `agentcore run ingest` | Start a fresh ingestion job for every data source on a deployed knowledge base |
|
|
184
|
+
| `agentcore view <type>` | List or view jobs (recommendation, batch-evaluation, ab-test, insights) |
|
|
185
|
+
| `agentcore archive <type>` | Delete a job on the service + clear local history |
|
|
186
|
+
| `agentcore stop <type>` | Stop a running batch-evaluation or ab-test |
|
|
187
|
+
| `agentcore promote ab-test` | Apply the winning variant to `agentcore.json` |
|
|
188
|
+
| `agentcore pause <type>` / `agentcore resume <type>` | Pause/resume a deployed online-eval, online-insights, or ab-test |
|
|
189
|
+
|
|
190
|
+
**Config bundles & datasets**
|
|
191
|
+
|
|
192
|
+
| Command | Description |
|
|
193
|
+
| --- | --- |
|
|
194
|
+
| `agentcore config-bundle versions` (alias `cb versions`) | List version history for a bundle |
|
|
195
|
+
| `agentcore config-bundle diff` | Diff two versions of a bundle |
|
|
196
|
+
| `agentcore config-bundle create-branch` | Create a new branch on an existing bundle |
|
|
197
|
+
| `agentcore dataset download` | Download a dataset version locally |
|
|
198
|
+
| `agentcore dataset publish-version` | Publish a new dataset version |
|
|
199
|
+
| `agentcore dataset remove-version` | Remove a dataset version |
|
|
200
|
+
|
|
201
|
+
**Observability & history**
|
|
202
|
+
|
|
203
|
+
| Command | Description |
|
|
204
|
+
| --- | --- |
|
|
205
|
+
| `agentcore logs` | Stream/search agent runtime logs |
|
|
206
|
+
| `agentcore logs evals` | Stream/search online-eval logs |
|
|
207
|
+
| `agentcore traces list` / `agentcore traces get` | List recent traces or download one to JSON |
|
|
208
|
+
| `agentcore evals history` | View past on-demand eval results |
|
|
209
|
+
|
|
210
|
+
**Utilities**
|
|
211
|
+
|
|
212
|
+
| Command | Description |
|
|
213
|
+
| --- | --- |
|
|
214
|
+
| `agentcore fetch access` | Fetch access info for deployed gateway or agent |
|
|
215
|
+
| `agentcore feedback` | Send feedback (with optional screenshot) to the AgentCore team |
|
|
216
|
+
| `agentcore update` | Check for and install CLI updates |
|
|
217
|
+
| `agentcore telemetry` | View or change telemetry preferences |
|