Commit 767fd4c
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 table1 parent 4a3d91d commit 767fd4c
14 files changed
Lines changed: 471 additions & 383 deletions
File tree
- docs
- src/assets
- __tests__/__snapshots__
- agents
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | | - | |
37 | | - | |
| 36 | + | |
| 37 | + | |
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
83 | | - | |
| 83 | + | |
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| 63 | + | |
63 | 64 | | |
64 | 65 | | |
65 | 66 | | |
66 | 67 | | |
67 | 68 | | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
74 | 75 | | |
75 | 76 | | |
76 | 77 | | |
| |||
85 | 86 | | |
86 | 87 | | |
87 | 88 | | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
92 | 93 | | |
93 | 94 | | |
94 | 95 | | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
95 | 105 | | |
96 | 106 | | |
97 | 107 | | |
| |||
102 | 112 | | |
103 | 113 | | |
104 | 114 | | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
105 | 125 | | |
106 | 126 | | |
107 | 127 | | |
| |||
129 | 149 | | |
130 | 150 | | |
131 | 151 | | |
132 | | - | |
| 152 | + | |
133 | 153 | | |
134 | 154 | | |
135 | 155 | | |
136 | 156 | | |
137 | 157 | | |
138 | 158 | | |
139 | 159 | | |
140 | | - | |
| 160 | + | |
141 | 161 | | |
142 | 162 | | |
143 | 163 | | |
| |||
0 commit comments