@@ -5,22 +5,29 @@ This project was created with the [AgentCore CLI](https://github.com/aws/agentco
55## Project Structure
66
77```
8- .
98my-project/
9+ ├── AGENTS.md # AI coding assistant context
1010├── agentcore/
11- │ ├── .env.local # API keys (gitignored)
12- │ ├── agentcore.json # Resource specifications
13- │ ├── aws-targets.json # Deployment targets
14- │ └── cdk/ # CDK infrastructure
15- ├── app/ # Application code
11+ │ ├── agentcore.json # Project config (agents, memories, credentials, gateways, evaluators)
12+ │ ├── aws-targets.json # Deployment targets (account + region)
13+ │ ├── .env.local # Secrets — API keys (gitignored)
14+ │ ├── .llm-context/ # TypeScript type definitions for AI assistants
15+ │ │ ├── agentcore.ts # AgentCoreProjectSpec types
16+ │ │ ├── aws-targets.ts # Deployment target types
17+ │ │ └── mcp.ts # Gateway and MCP tool types
18+ │ └── cdk/ # CDK infrastructure (@aws/agentcore-cdk)
19+ ├── app/ # Agent application code
20+ └── evaluators/ # Custom evaluator code (if any)
1621```
1722
1823## Getting Started
1924
2025### Prerequisites
2126
2227- ** Node.js** 20.x or later
23- - ** uv** for Python agents ([ install] ( https://docs.astral.sh/uv/getting-started/installation/ ) )
28+ - ** Python 3.10+** and ** uv** for Python agents ([ install uv] ( https://docs.astral.sh/uv/getting-started/installation/ ) )
29+ - ** AWS credentials** configured (` aws configure ` or environment variables)
30+ - ** Docker** (only for Container build agents)
2431
2532### Development
2633
@@ -38,42 +45,60 @@ Deploy to AWS:
3845agentcore deploy
3946```
4047
41- Or use CDK directly:
48+ ## Commands
4249
43- ``` bash
44- cd agentcore/cdk
45- npx cdk deploy
46- ```
50+ | Command | Description |
51+ | --- | --- |
52+ | ` agentcore create ` | Create a new AgentCore project |
53+ | ` agentcore add ` | Add resources (agent, memory, credential, gateway, evaluator, policy) |
54+ | ` agentcore remove ` | Remove resources |
55+ | ` agentcore dev ` | Run agent locally with hot-reload |
56+ | ` agentcore deploy ` | Deploy to AWS via CDK |
57+ | ` agentcore status ` | Show deployment status |
58+ | ` agentcore invoke ` | Invoke agent (local or deployed) |
59+ | ` agentcore logs ` | View agent logs |
60+ | ` agentcore traces ` | View agent traces |
61+ | ` agentcore eval ` | Run evaluations |
62+ | ` agentcore package ` | Package agent artifacts |
63+ | ` agentcore validate ` | Validate configuration |
64+ | ` agentcore pause ` | Pause a deployed agent |
65+ | ` agentcore resume ` | Resume a paused agent |
66+ | ` agentcore fetch ` | Fetch remote resource definitions |
67+ | ` agentcore import ` | Import existing resources |
68+ | ` agentcore update ` | Check for CLI updates |
4769
4870## Configuration
4971
50- Edit the JSON files in ` agentcore/ ` to configure your agents, memory, and credentials. See ` agentcore/.llm-context/ ` for
51- type definitions and validation constraints.
72+ Edit the JSON files in ` agentcore/ ` to configure your project. See ` agentcore/.llm-context/ ` for type definitions and validation constraints.
5273
53- The project uses a ** flat resource model** where agents, memories, and credentials are top-level arrays in
54- ` agentcore.json ` .
74+ The project uses a ** flat resource model** — agents, memories, credentials, gateways, evaluators, and policies are top-level arrays in ` agentcore.json ` . Resources are independent; agents discover memories and credentials at runtime via environment variables or SDK calls.
5575
56- ## Commands
76+ ## Resources
5777
58- | Command | Description |
59- | -------------------- | ----------------------------------------------- |
60- | ` agentcore create ` | Create a new AgentCore project |
61- | ` agentcore add ` | Add resources (agent, memory, credential, target) |
62- | ` agentcore remove ` | Remove resources |
63- | ` agentcore dev ` | Run agent locally |
64- | ` agentcore deploy ` | Deploy to AWS |
65- | ` agentcore status ` | Show deployment status |
66- | ` agentcore invoke ` | Invoke agent (local or deployed) |
67- | ` agentcore package ` | Package agent artifacts |
68- | ` agentcore validate ` | Validate configuration |
69- | ` agentcore update ` | Check for CLI updates |
78+ | Resource | Purpose |
79+ | --- | --- |
80+ | Agent (runtime) | HTTP, MCP, or A2A agent deployed to AgentCore Runtime |
81+ | Memory | Persistent context storage with configurable strategies |
82+ | Credential | API key or OAuth credential providers |
83+ | Gateway | MCP gateway that routes tool calls to targets |
84+ | Gateway Target | Tool implementation (Lambda, MCP server, OpenAPI, Smithy, API Gateway) |
85+ | Evaluator | Custom LLM-as-a-Judge or code-based evaluation |
86+ | Online Eval Config | Continuous evaluation pipeline for deployed agents |
87+ | Policy | Cedar authorization policies for gateway tools |
7088
7189### Agent Types
7290
73- - ** Template agents** : Created from framework templates (Strands, LangChain_LangGraph, CrewAI, GoogleADK, OpenAIAgents )
91+ - ** Template agents** : Created from framework templates (Strands, LangChain/LangGraph, GoogleADK, OpenAI Agents, Autogen )
7492- ** BYO agents** : Bring your own code with ` agentcore add agent --type byo `
93+ - ** Import agents** : Import existing Bedrock agents with ` agentcore import `
94+
95+ ### Build Types
96+
97+ - ** CodeZip** : Python source packaged as a zip and deployed directly to AgentCore Runtime
98+ - ** Container** : Docker image built via CodeBuild (ARM64), pushed to ECR, and deployed to AgentCore Runtime
7599
76100## Documentation
77101
78- - [ AgentCore CLI Documentation] ( https://github.com/aws/agentcore-cli )
102+ - [ AgentCore CLI] ( https://github.com/aws/agentcore-cli )
103+ - [ AgentCore CDK Constructs] ( https://github.com/aws/agentcore-l3-cdk-constructs )
79104- [ Amazon Bedrock AgentCore] ( https://aws.amazon.com/bedrock/agentcore/ )
0 commit comments