Skip to content

Commit 767fd4c

Browse files
authored
docs: fix 30 documentation inaccuracies found by source code audit (#697)
* docs: fix 30 documentation inaccuracies found by source code audit - configuration.md: fix networkMode PRIVATE→VPC, remove stale mcp.json section, add 7 missing AgentEnvSpec fields, add Node.js runtimes, fix gateway name max 63→100, list all 6 targetType values, fix memory strategies wording, fix deployed-state.json path, add missing project fields, fix CUSTOM_JWT field requirements, add customClaims field - README.md: add CrewAI framework, update all 4 default model IDs, add missing command sections - frameworks.md: add CrewAI with model providers, add protocol compatibility matrix (HTTP/MCP/A2A) - commands.md: fix agent name max 64→48 chars, add fetch access section, add policy-engine/policy to status --type, remove ghost --tool-filter-description flag, fix model ID date - gateway.md: add enableSemanticSearch/exceptionLevel config options, fix mcp.json→agentcore.json, remove api-key from MCP Server auth - transaction_search.md: fix traces command syntax - container-builds.md: remove nonexistent --progress flag - evals.md: fix model date 20250929→20250514 - local-development.md: fix mcp.json→agentcore.json - AGENTS.md: remove AutoGen, remove stale mcp.json reference - src/assets/README.md: add CrewAI to template list - src/assets/agents/AGENTS.md: remove AutoGen Constraint: All fixes verified against Zod schemas and CLI runtime Constraint: CLI --help text bugs left for separate agent Confidence: high Scope-risk: narrow * style: run prettier on documentation files * test: update asset snapshots for edited README.md and AGENTS.md * ci: trigger build workflow * 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 * docs: fix stale agents reference in gateway example Update `"agents": [...]` to `"runtimes": [...]` in the gateway configuration example to match the schema rename in #706. * docs: rename --agent flags to --runtime and remove stale type fields Update all documentation to reflect upstream renames: - --agent → --runtime, -a → -r across all commands - --agent-arn → --runtime-arn, --agent-runtime-id → --runtime-id - Remove stale "type" fields from JSON examples in evals.md, memory.md, and container-builds.md Constraint: --agent-id, --agent-alias-id, --agent-client-id, --agent-client-secret are unchanged (different semantics) Constraint: --type agent filter value in status/fetch stays as-is Confidence: high Scope-risk: narrow * docs: add missing flags and fix --lines → --limit - Add -H, --header flag to dev and invoke commands - Add --bearer-token flag to invoke command - Fix --lines → --limit in evals.md logs evals section Confidence: high Scope-risk: narrow * docs: fix stale gateway flags and add missing CLI flags - Rename --agent-client-id → --client-id, --agent-client-secret → --client-secret in gateway docs (naming unification #705) - Add missing flags to add agent: --authorizer-type, --discovery-url, --allowed-audience, --allowed-clients, --allowed-scopes, --custom-claims, --client-id, --client-secret, --idle-timeout, --max-lifetime - Add missing flags to create: --idle-timeout, --max-lifetime - Add missing flags to add gateway: --runtimes, --custom-claims, --policy-engine, --policy-engine-mode - Fix --exception-level values: NONE/ALL (was undocumented) Confidence: high Scope-risk: narrow * docs: fix --exception-level valid values to NONE/DEBUG The CLI help text says ALL but the schema (GatewayExceptionLevelSchema) defines the valid values as NONE and DEBUG. Aligns commands.md with gateway.md and the Zod schema. * docs: fix stale fields and add flags from upstream v0.5–v0.7 - Remove stale "type": "AgentCoreMemory" from memory streaming example - Add memory streaming flags: --delivery-type, --data-stream-arn, --stream-content-level, --stream-delivery-resources - Add --exec to dev command flag table (Container agents) - Add --skip-install to create command flag table - Add --identity-name to fetch access flag table
1 parent 4a3d91d commit 767fd4c

14 files changed

Lines changed: 471 additions & 383 deletions

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` and `mcp.json`, with tags flowing
74-
through to deployed 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: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,18 @@ agentcore invoke
6060
| ------------------- | ----------------------------- |
6161
| Strands Agents | AWS-native, streaming support |
6262
| LangChain/LangGraph | Graph-based workflows |
63+
| CrewAI | Multi-agent orchestration |
6364
| Google ADK | Gemini models only |
6465
| OpenAI Agents | OpenAI models only |
6566

6667
## Supported Model Providers
6768

68-
| Provider | API Key Required | Default Model |
69-
| -------------- | ------------------------- | ----------------------------- |
70-
| Amazon Bedrock | No (uses AWS credentials) | claude-sonnet-4-5-20250929-v1 |
71-
| Anthropic | Yes | claude-sonnet-4-5-20250929 |
72-
| Google Gemini | Yes | gemini-2.5-flash |
73-
| OpenAI | Yes | gpt-4o |
69+
| Provider | API Key Required | Default Model |
70+
| -------------- | ------------------------- | -------------------------------------------- |
71+
| Amazon Bedrock | No (uses AWS credentials) | us.anthropic.claude-sonnet-4-5-20250514-v1:0 |
72+
| Anthropic | Yes | claude-sonnet-4-5-20250514 |
73+
| Google Gemini | Yes | gemini-2.5-flash |
74+
| OpenAI | Yes | gpt-4.1 |
7475

7576
## Commands
7677

@@ -85,13 +86,22 @@ agentcore invoke
8586

8687
### Resource Management
8788

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

9394
> **Note**: Run `agentcore deploy` after `add` or `remove` to update resources in AWS.
9495
96+
### Observability
97+
98+
| Command | Description |
99+
| ------------- | --------------------------------------- |
100+
| `logs` | Stream or search agent runtime logs |
101+
| `traces list` | List recent traces for a deployed agent |
102+
| `traces get` | Download a trace to a JSON file |
103+
| `status` | Show deployed resource details |
104+
95105
### Evaluations
96106

97107
| Command | Description |
@@ -102,6 +112,16 @@ agentcore invoke
102112
| `evals history` | View past eval run results |
103113
| `pause online-eval` | Pause a deployed online eval config |
104114
| `resume online-eval` | Resume a paused online eval config |
115+
| `logs evals` | Stream or search online eval logs |
116+
117+
### Utilities
118+
119+
| Command | Description |
120+
| -------------- | ----------------------------------------- |
121+
| `validate` | Validate configuration files |
122+
| `package` | Package agent artifacts without deploying |
123+
| `fetch access` | Fetch access info for deployed resources |
124+
| `update` | Check for and install CLI updates |
105125

106126
## Project Structure
107127

@@ -129,15 +149,15 @@ my-project/
129149

130150
Projects use JSON schema files in the `agentcore/` directory:
131151

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

136156
## Capabilities
137157

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

143163
## Documentation

0 commit comments

Comments
 (0)