refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings) - #706

Merged
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes
Mar 27, 2026
Merged

refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)#706
jesseturner21 merged 5 commits into
mainfrom
rename-agents-to-runtimes

Conversation

@jesseturner21

@jesseturner21jesseturner21 commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Description

Renames agent terminology to runtime across schema, CLI flags, and MCP bindings to better reflect the resource type (AgentCoreRuntime). This is a breaking change to the agentcore.json schema.

Commit 1: Schema rename agentsruntimes

  • JSON schema: agentcore.schema.v1.json property "agents""runtimes"
  • Zod schemas: agentcore-project.ts, deployed-state.ts
  • LLM-compacted types: agentcore.ts, mcp.ts
  • Source files: All .agents property accesses on AgentCoreProjectSpec and DeployedResourceState.runtimes
  • Tests: All test fixtures and assertions updated
  • Docs: configuration.md JSON examples updated

Commit 2: CLI flags --agent--runtime

  • --agent <name>--runtime <name> (with -a-r short alias)
  • --agent-runtime-id--runtime-id
  • --agent-arn--runtime-arn
  • --agents--runtimes (gateway primitive)
  • resolveAgent() updated to accept { runtime?: string }
  • All action handlers, option types, error messages, and tests updated
  • Unchanged: --agent-id, --agent-alias-id (Bedrock Agent IDs), agentcore add agent / agentcore remove agent command names

Commit 3: MCP bindings agentNameruntimeName

  • McpRuntimeBindingSchema.agentNameruntimeName
  • attach.ts binding logic updated
  • JSON schema, LLM-compacted types, and tests updated

NOT changed (intentionally):

  • ParsedStarterToolkitConfig.agents — external YAML parser type
  • CLI command names (add agent, remove agent)
  • --agent-id and --agent-alias-id (Bedrock Agent identifiers)
  • Directory paths in codeLocation values

Related Issue

Closes #

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Results:

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Companion PR: https://github.com/aws/agentcore-l3-cdk-constructs/pull/124


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions

Copy link
Copy Markdown
Contributor

Package Tarball

aws-agentcore-0.3.0-preview.9.0.tgz

How to install

npm install https://github.com/aws/agentcore-cli/releases/download/pr-706-tarball/aws-agentcore-0.3.0-preview.9.0.tgz

The top-level 'agents' array property in agentcore.json is renamed to
'runtimes' to better reflect the resource type (AgentCoreRuntime).
This is a schema-only rename — no changes to CLI commands, flags, or
user-facing strings.
Scope: JSON schema, Zod schemas, LLM-compacted types, deployed-state,
all source references, tests, and documentation.
Rename CLI flags from agent terminology to runtime:
- --agent <name> → --runtime <name> (with -a → -r short alias)
- --agent-runtime-id → --runtime-id
- --agent-arn → --runtime-arn
- --agents → --runtimes (gateway primitive)
Update resolveAgent() to accept { runtime?: string }.
Update all action handlers, option types, error messages, and tests.
Keep --agent-id and --agent-alias-id unchanged (Bedrock Agent IDs).
Keep 'agentcore add agent' / 'agentcore remove agent' commands unchanged.
… make type optional
- Rename `agentName` to `runtimeName` in McpRuntimeBindingSchema and
all consuming code (attach.ts, llm-compacted types, JSON schema)
- Make `type: "AgentCoreRuntime"` optional on AgentEnvSpec for backward
compatibility; stop emitting it in new runtime configs
- Update tests to match new schema shape
@jesseturner21
jesseturner21force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0CompareMarch 27, 2026 22:19
@github-actionsgithub-actionsBot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21jesseturner21 changed the title refactor(schema): rename 'agents' to 'runtimes'refactor: rename agents to runtimes (schema, CLI flags, MCP bindings)Mar 27, 2026
The integ test was still using --agent for online-eval commands,
which was renamed to --runtime in the CLI flags rename commit.
Also removes unused addOnlineEvalArgs variable.
@github-actionsgithub-actionsBot removed the size/l PR size: L label Mar 27, 2026
@github-actionsgithub-actionsBot added the size/l PR size: L label Mar 27, 2026
Comment threadinteg-tests/add-remove-evaluator.test.ts
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines46%6553 / 14243
🔵Statements45.57%6963 / 15277
🔵Functions44.71%1176 / 2630
🔵Branches46.09%4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21
jesseturner21 merged commit d41e14b into mainMar 27, 2026
23 of 27 checks passed
@jesseturner21
jesseturner21 deleted the rename-agents-to-runtimes branch March 27, 2026 22:57
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 27, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Mar 28, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit to aidandaly24/agentcore-cli that referenced this pull request Apr 8, 2026
Update `"agents": [...]` to `"runtimes": [...]` in the gateway
configuration example to match the schema rename in aws#706.
aidandaly24 added a commit that referenced this pull request Apr 9, 2026
)
* 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/lPR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseturner21@Hweinstock