Skip to content

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

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

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

Conversation

@jesseturner21
Copy link
Copy Markdown
Contributor

@jesseturner21 jesseturner21 commented Mar 27, 2026

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.

@jesseturner21 jesseturner21 requested a review from a team March 27, 2026 18:49
@github-actions github-actions bot added the size/l PR size: L label Mar 27, 2026
@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

@github-actions github-actions bot removed the size/l PR size: L label Mar 27, 2026
@github-actions github-actions bot added the size/l PR size: L label Mar 27, 2026
@jesseturner21 jesseturner21 force-pushed the rename-agents-to-runtimes branch from a845ed9 to 624d538 Compare March 27, 2026 22:18
@github-actions github-actions bot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
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 jesseturner21 force-pushed the rename-agents-to-runtimes branch from 624d538 to ffd1bf0 Compare March 27, 2026 22:19
@github-actions github-actions bot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@jesseturner21 jesseturner21 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-actions github-actions bot added size/l PR size: L and removed size/l PR size: L labels Mar 27, 2026
@github-actions github-actions bot removed the size/l PR size: L label Mar 27, 2026
@github-actions github-actions bot added the size/l PR size: L label Mar 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 46% 6553 / 14243
🔵 Statements 45.57% 6963 / 15277
🔵 Functions 44.71% 1176 / 2630
🔵 Branches 46.09% 4331 / 9395
Generated in workflow #1487 for commit 20d0c04 by the Vitest Coverage Report Action

@jesseturner21 jesseturner21 merged commit d41e14b into main Mar 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/l PR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants