Skip to content

Commit 0c88152

Browse files
aidandaly24aidandaly24
committed
docs: update docs for upstream schema refactor and naming unification
- Remove `type` fields from agent, memory, evaluator, online-eval-config examples and field tables (removed in #709) - Remove `modelProvider` from agent spec (removed in #709) - Rename credential `type` to `authorizerType` (renamed in #709) - Rename `add identity` to `add credential` everywhere (#705) - Replace `--force` with `-y/--yes` on remove commands (#705) - Replace `--plan` with `--dry-run` on deploy command (#705) - Update snapshot for src/assets/README.md change
1 parent a0facb5 commit 0c88152

File tree

7 files changed

+42
-54
lines changed

7 files changed

+42
-54
lines changed

‎AGENTS.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ These options are available on all commands:
3131
## CLI Commands
3232

3333
- `create` - Create new AgentCore project
34-
- `add` - Add resources (agent, memory, identity, evaluator, online-eval, gateway, gateway-target, policy-engine,
34+
- `add` - Add resources (agent, memory, credential, evaluator, online-eval, gateway, gateway-target, policy-engine,
3535
policy)
36-
- `remove` - Remove resources (agent, memory, identity, evaluator, online-eval, gateway, gateway-target, policy-engine,
37-
policy, all)
36+
- `remove` - Remove resources (agent, memory, credential, evaluator, online-eval, gateway, gateway-target,
37+
policy-engine, policy, all)
3838
- `deploy` - Deploy infrastructure to AWS
3939
- `status` - Check deployment status
4040
- `dev` - Local development server (CodeZip: uvicorn with hot-reload; Container: Docker build + run with volume mount)
@@ -68,10 +68,10 @@ These options are available on all commands:
6868

6969
## Primitives Architecture
7070

71-
All resource types (agent, memory, identity, evaluator, online-eval, gateway, gateway-target, policy-engine, policy) are
72-
modeled as **primitives** -- self-contained classes in `src/cli/primitives/` that own the full add/remove lifecycle for
73-
their resource type. Resources support config-driven tagging via `agentcore.json`, with tags flowing through to deployed
74-
CloudFormation resources.
71+
All resource types (agent, memory, credential, evaluator, online-eval, gateway, gateway-target, policy-engine, policy)
72+
are modeled as **primitives** -- self-contained classes in `src/cli/primitives/` that own the full add/remove lifecycle
73+
for their resource type. Resources support config-driven tagging via `agentcore.json`, with tags flowing through to
74+
deployed CloudFormation resources.
7575

7676
Each primitive extends `BasePrimitive` and implements: `add()`, `remove()`, `previewRemove()`, `getRemovable()`,
7777
`registerCommands()`, and `addScreen()`.
@@ -80,7 +80,7 @@ Current primitives:
8080

8181
- `AgentPrimitive` — agent creation (template + BYO), removal, credential resolution
8282
- `MemoryPrimitive` — memory creation with strategies, removal
83-
- `CredentialPrimitive` — credential/identity creation, .env management, removal
83+
- `CredentialPrimitive` — credential creation, .env management, removal
8484
- `EvaluatorPrimitive` — custom evaluator creation/removal with cross-reference validation
8585
- `OnlineEvalConfigPrimitive` — online eval config creation/removal
8686
- `GatewayPrimitive` — gateway creation/removal

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ agentcore invoke
8686

8787
### Resource Management
8888

89-
| Command | Description |
90-
| -------- | ------------------------------------------------- |
91-
| `add` | Add agents, memory, identity, evaluators, targets |
92-
| `remove` | Remove resources from project |
89+
| Command | Description |
90+
| -------- | ---------------------------------------------------- |
91+
| `add` | Add agents, memory, credentials, evaluators, targets |
92+
| `remove` | Remove resources from project |
9393

9494
> **Note**: Run `agentcore deploy` after `add` or `remove` to update resources in AWS.
9595
@@ -149,15 +149,15 @@ my-project/
149149

150150
Projects use JSON schema files in the `agentcore/` directory:
151151

152-
- `agentcore.json` - Agent specifications, memory, identity, evaluators, online evals
152+
- `agentcore.json` - Agent specifications, memory, credentials, evaluators, online evals
153153
- `deployed-state.json` - Runtime state in agentcore/.cli/ (auto-managed)
154154
- `aws-targets.json` - Deployment targets (account, region)
155155

156156
## Capabilities
157157

158158
- **Runtime** - Managed execution environment for deployed agents
159159
- **Memory** - Semantic, summarization, and user preference strategies
160-
- **Identity** - Secure API key management via Secrets Manager
160+
- **Credentials** - Secure API key management via Secrets Manager
161161
- **Evaluations** - LLM-as-a-Judge for on-demand and continuous agent quality monitoring
162162

163163
## Documentation

‎docs/commands.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Deploy infrastructure to AWS.
9898
agentcore deploy
9999
agentcore deploy -y # Auto-confirm
100100
agentcore deploy -y -v # Auto-confirm with verbose output
101-
agentcore deploy --plan # Preview without deploying (dry-run)
101+
agentcore deploy --dry-run # Preview without deploying
102102
agentcore deploy --diff # Show CDK diff without deploying
103103
agentcore deploy --target staging -y # Deploy to a specific target
104104
agentcore deploy -y --json # JSON output
@@ -109,7 +109,7 @@ agentcore deploy -y --json # JSON output
109109
| `--target <name>` | Deployment target name (default: `"default"`) |
110110
| `-y, --yes` | Auto-confirm prompts |
111111
| `-v, --verbose` | Resource-level deployment events |
112-
| `--plan` | Preview deployment without deploying |
112+
| `--dry-run` | Preview deployment without deploying |
113113
| `--diff` | Show CDK diff without deploying |
114114
| `--json` | JSON output |
115115

@@ -360,18 +360,18 @@ agentcore add gateway-target \
360360
> `open-api-schema` requires `--outbound-auth` (`oauth` or `api-key`). `api-gateway` supports `api-key` or `none`.
361361
> `mcp-server` supports `oauth` or `none`.
362362
363-
### add identity
363+
### add credential
364364

365365
Add a credential to the project. Supports API key and OAuth credential types.
366366

367367
```bash
368368
# API key credential
369-
agentcore add identity \
369+
agentcore add credential \
370370
--name OpenAI \
371371
--api-key sk-...
372372

373373
# OAuth credential
374-
agentcore add identity \
374+
agentcore add credential \
375375
--name MyOAuthProvider \
376376
--type oauth \
377377
--discovery-url https://idp.example.com/.well-known/openid-configuration \
@@ -441,23 +441,23 @@ agentcore add online-eval \
441441
Remove resources from project.
442442

443443
```bash
444-
agentcore remove agent --name MyAgent --force
444+
agentcore remove agent --name MyAgent -y
445445
agentcore remove memory --name SharedMemory
446-
agentcore remove identity --name OpenAI
446+
agentcore remove credential --name OpenAI
447447
agentcore remove evaluator --name ResponseQuality
448448
agentcore remove online-eval --name QualityMonitor
449449
agentcore remove gateway --name MyGateway
450450
agentcore remove gateway-target --name WeatherTools
451451

452452
# Reset everything
453-
agentcore remove all --force
453+
agentcore remove all -y
454454
agentcore remove all --dry-run # Preview
455455
```
456456

457457
| Flag | Description |
458458
| --------------- | ------------------------- |
459459
| `--name <name>` | Resource name |
460-
| `--force` | Skip confirmation |
460+
| `-y, --yes` | Skip confirmation |
461461
| `--dry-run` | Preview (remove all only) |
462462
| `--json` | JSON output |
463463

@@ -744,7 +744,7 @@ agentcore help modes # Explain interactive vs non-interactive modes
744744
```bash
745745
# Validate, preview, and deploy
746746
agentcore validate
747-
agentcore deploy --plan --json # Preview changes
747+
agentcore deploy --dry-run --json # Preview changes
748748
agentcore deploy -y --json # Deploy with auto-confirm
749749
```
750750

‎docs/configuration.md‎

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,12 @@ Main project configuration using a **flat resource model**. Agents, memories, an
2727
},
2828
"runtimes": [
2929
{
30-
"type": "AgentCoreRuntime",
3130
"name": "MyAgent",
3231
"build": "CodeZip",
3332
"entrypoint": "main.py",
3433
"codeLocation": "app/MyAgent/",
3534
"runtimeVersion": "PYTHON_3_13",
3635
"networkMode": "PUBLIC",
37-
"modelProvider": "Bedrock",
3836
"protocol": "HTTP"
3937
}
4038
],
@@ -117,7 +115,6 @@ resource-level value takes precedence for that specific resource.
117115
},
118116
"runtimes": [
119117
{
120-
"type": "AgentCoreRuntime",
121118
"name": "MyAgent",
122119
"tags": {
123120
"Environment": "staging",
@@ -165,7 +162,6 @@ on the next deployment.
165162

166163
```json
167164
{
168-
"type": "AgentCoreRuntime",
169165
"name": "MyAgent",
170166
"build": "CodeZip",
171167
"entrypoint": "main.py",
@@ -181,7 +177,6 @@ on the next deployment.
181177

182178
| Field | Required | Description |
183179
| ------------------------- | -------- | --------------------------------------------------------------- |
184-
| `type` | Yes | Always `"AgentCoreRuntime"` |
185180
| `name` | Yes | Agent name (1-48 chars, alphanumeric + underscore) |
186181
| `build` | Yes | `"CodeZip"` or `"Container"` |
187182
| `entrypoint` | Yes | Entry file (e.g., `main.py` or `main.py:handler`) |
@@ -190,7 +185,6 @@ on the next deployment.
190185
| `networkMode` | No | `"PUBLIC"` (default) or `"VPC"` |
191186
| `networkConfig` | No | VPC configuration (subnets, security groups) |
192187
| `protocol` | No | `"HTTP"` (default), `"MCP"`, or `"A2A"` |
193-
| `modelProvider` | No | `"Bedrock"`, `"Anthropic"`, `"OpenAI"`, `"Gemini"` |
194188
| `envVars` | No | Custom environment variables |
195189
| `instrumentation` | No | OpenTelemetry settings |
196190
| `authorizerType` | No | `"AWS_IAM"` or `"CUSTOM_JWT"` |
@@ -220,7 +214,6 @@ on the next deployment.
220214

221215
```json
222216
{
223-
"type": "AgentCoreMemory",
224217
"name": "MyMemory",
225218
"eventExpiryDuration": 30,
226219
"strategies": [{ "type": "SEMANTIC" }, { "type": "SUMMARIZATION" }]
@@ -229,7 +222,6 @@ on the next deployment.
229222

230223
| Field | Required | Description |
231224
| --------------------- | -------- | --------------------------------------------------------------- |
232-
| `type` | Yes | Always `"AgentCoreMemory"` |
233225
| `name` | Yes | Memory name (1-48 chars) |
234226
| `eventExpiryDuration` | Yes | Days until events expire (7-365) |
235227
| `strategies` | Yes | Array of memory strategies (can be empty for short-term memory) |
@@ -262,36 +254,36 @@ Strategy configuration:
262254

263255
```json
264256
{
265-
"type": "ApiKeyCredentialProvider",
257+
"authorizerType": "ApiKeyCredentialProvider",
266258
"name": "OpenAI"
267259
}
268260
```
269261

270-
| Field | Required | Description |
271-
| ------ | -------- | ----------------------------------- |
272-
| `type` | Yes | Always `"ApiKeyCredentialProvider"` |
273-
| `name` | Yes | Credential name (1-128 chars) |
262+
| Field | Required | Description |
263+
| ---------------- | -------- | ----------------------------------- |
264+
| `authorizerType` | Yes | Always `"ApiKeyCredentialProvider"` |
265+
| `name` | Yes | Credential name (1-128 chars) |
274266

275267
### OAuth Credential
276268

277269
```json
278270
{
279-
"type": "OAuthCredentialProvider",
271+
"authorizerType": "OAuthCredentialProvider",
280272
"name": "MyOAuthProvider",
281273
"discoveryUrl": "https://idp.example.com/.well-known/openid-configuration",
282274
"scopes": ["read", "write"]
283275
}
284276
```
285277

286-
| Field | Required | Description |
287-
| -------------- | -------- | ------------------------------------------------------ |
288-
| `type` | Yes | Always `"OAuthCredentialProvider"` |
289-
| `name` | Yes | Credential name (1-128 chars) |
290-
| `discoveryUrl` | Yes | OIDC discovery URL (must be a valid URL) |
291-
| `scopes` | No | Array of OAuth scopes |
292-
| `vendor` | No | Credential provider vendor (default: `"CustomOauth2"`) |
293-
| `managed` | No | Whether auto-created by the CLI (do not edit) |
294-
| `usage` | No | `"inbound"` or `"outbound"` |
278+
| Field | Required | Description |
279+
| ---------------- | -------- | ------------------------------------------------------ |
280+
| `authorizerType` | Yes | Always `"OAuthCredentialProvider"` |
281+
| `name` | Yes | Credential name (1-128 chars) |
282+
| `discoveryUrl` | Yes | OIDC discovery URL (must be a valid URL) |
283+
| `scopes` | No | Array of OAuth scopes |
284+
| `vendor` | No | Credential provider vendor (default: `"CustomOauth2"`) |
285+
| `managed` | No | Whether auto-created by the CLI (do not edit) |
286+
| `usage` | No | `"inbound"` or `"outbound"` |
295287

296288
The actual secrets (API keys, client IDs, client secrets) are stored in `.env.local` for local development and in
297289
AgentCore Identity service for deployed environments.
@@ -304,7 +296,6 @@ See [Evaluations](evals.md) for the full guide.
304296

305297
```json
306298
{
307-
"type": "CustomEvaluator",
308299
"name": "ResponseQuality",
309300
"level": "SESSION",
310301
"description": "Evaluate response quality",
@@ -325,7 +316,6 @@ See [Evaluations](evals.md) for the full guide.
325316

326317
| Field | Required | Description |
327318
| ------------- | -------- | ----------------------------------------------- |
328-
| `type` | Yes | Always `"CustomEvaluator"` |
329319
| `name` | Yes | Evaluator name (1-48 chars, alphanumeric + `_`) |
330320
| `level` | Yes | `"SESSION"`, `"TRACE"`, or `"TOOL_CALL"` |
331321
| `description` | No | Evaluator description |
@@ -359,7 +349,6 @@ See [Evaluations](evals.md) for the full guide.
359349

360350
```json
361351
{
362-
"type": "OnlineEvaluationConfig",
363352
"name": "QualityMonitor",
364353
"agent": "MyAgent",
365354
"evaluators": ["ResponseQuality", "Builtin.Faithfulness"],
@@ -370,7 +359,6 @@ See [Evaluations](evals.md) for the full guide.
370359

371360
| Field | Required | Description |
372361
| ---------------- | -------- | ------------------------------------------------------------ |
373-
| `type` | Yes | Always `"OnlineEvaluationConfig"` |
374362
| `name` | Yes | Config name (1-48 chars, alphanumeric + `_`) |
375363
| `agent` | Yes | Agent name to monitor (must match a project agent) |
376364
| `evaluators` | Yes | Array of evaluator names, `Builtin.*` IDs, or evaluator ARNs |

‎docs/gateway.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ agentcore add gateway-target \
172172
You can also reference an existing credential:
173173

174174
```bash
175-
agentcore add identity \
175+
agentcore add credential \
176176
--name MyOAuthProvider \
177177
--type oauth \
178178
--discovery-url https://auth.example.com/.well-known/openid-configuration \

‎src/assets/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The project uses a **flat resource model** where agents, memories, and credentia
5858
| Command | Description |
5959
| -------------------- | ----------------------------------------------- |
6060
| `agentcore create` | Create a new AgentCore project |
61-
| `agentcore add` | Add resources (agent, memory, identity, target) |
61+
| `agentcore add` | Add resources (agent, memory, credential, target) |
6262
| `agentcore remove` | Remove resources |
6363
| `agentcore dev` | Run agent locally |
6464
| `agentcore deploy` | Deploy to AWS |

‎src/assets/__tests__/__snapshots__/assets.snapshot.test.ts.snap‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3912,7 +3912,7 @@ The project uses a **flat resource model** where agents, memories, and credentia
39123912
| Command | Description |
39133913
| -------------------- | ----------------------------------------------- |
39143914
| \`agentcore create\` | Create a new AgentCore project |
3915-
| \`agentcore add\` | Add resources (agent, memory, identity, target) |
3915+
| \`agentcore add\` | Add resources (agent, memory, credential, target) |
39163916
| \`agentcore remove\` | Remove resources |
39173917
| \`agentcore dev\` | Run agent locally |
39183918
| \`agentcore deploy\` | Deploy to AWS |

0 commit comments

Comments
 (0)