Skip to content

Commit 84a6dde

Browse files
authored
docs: update vended AGENTS.md, README.md, and llm-context references (#898)
* docs: update vended AGENTS.md, README.md, and llm-context references Rewrite vended documentation to reflect the current state of the CLI: - Add all current resources (gateways, evaluators, policies, online-eval) - Add all CLI commands (logs, traces, eval, pause, resume, fetch, import) - Add protocols (HTTP, MCP, A2A) and all supported frameworks - Add Node.js runtime versions alongside Python - Add VPC network mode documentation - Reference @aws/agentcore-cdk L3 constructs and CDK repo - Add mcp.ts to llm-context README file table - Update internal assets/AGENTS.md with full directory layout * test: update asset snapshot tests to match new docs content
1 parent 74a35cb commit 84a6dde

5 files changed

Lines changed: 351 additions & 196 deletions

File tree

src/assets/AGENTS.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,47 @@
22

33
This directory stores:
44

5-
- Template assets for agents written in different Languages, SDKs and having different configurations
5+
- Template assets for agents written in different languages, SDKs, and configurations
66
- Container templates (`container/python/`) with `Dockerfile` and `.dockerignore` for Container build agents
7+
- Vended documentation (`README.md`, `agents/AGENTS.md`) copied into user projects at create time
8+
- CDK project template (`cdk/`) using `@aws/agentcore-cdk` L3 constructs
9+
- Evaluator templates (`evaluators/`) for code-based evaluators
10+
- MCP tool templates (`mcp/`) for Lambda and AgentCoreRuntime compute
711

812
### Directory Layout
913

1014
```
1115
assets/
12-
├── python/ # Framework templates (one per SDK)
13-
│ ├── strands/
14-
│ ├── langchain_langgraph/
15-
│ ├── googleadk/
16-
│ ├── openaiagents/
17-
│ └── autogen/
16+
├── README.md # Vended to project root as project README
17+
├── AGENTS.md # This file — internal dev context
18+
├── agents/
19+
│ └── AGENTS.md # Vended to project root for AI coding assistants
20+
├── python/ # Framework templates (one per SDK per protocol)
21+
│ ├── http/ # HTTP protocol agents
22+
│ │ ├── strands/
23+
│ │ ├── langchain_langgraph/
24+
│ │ ├── googleadk/
25+
│ │ ├── openaiagents/
26+
│ │ └── autogen/
27+
│ ├── mcp/ # MCP protocol agents
28+
│ │ └── standalone/
29+
│ └── a2a/ # A2A protocol agents
30+
│ ├── strands/
31+
│ ├── langchain_langgraph/
32+
│ └── googleadk/
33+
├── typescript/ # TypeScript agent templates
1834
├── container/ # Container build templates
1935
│ └── python/
2036
│ ├── Dockerfile
2137
│ └── dockerignore.template
22-
└── agents/ # AGENTS.md vended to user projects
38+
├── cdk/ # CDK project template (@aws/agentcore-cdk)
39+
├── evaluators/ # Code-based evaluator templates
40+
└── mcp/ # MCP tool templates (Lambda + AgentCoreRuntime)
41+
├── python/
42+
└── python-lambda/
2343
```
2444

25-
The rendering logic is rooted in the `AgentEnvSpec` and must ALWAYS respect the configuration in the Spec.
45+
The rendering logic is rooted in the `AgentEnvSpec` and must ALWAYS respect the configuration in the spec.
2646

2747
For Container builds, `BaseRenderer.render()` automatically copies the `container/<language>/` templates (Dockerfile,
2848
.dockerignore) into the agent directory when `buildType === 'Container'`.
@@ -31,7 +51,10 @@ For Container builds, `BaseRenderer.render()` automatically copies the `containe
3151

3252
- Always make sure the templates are as close to working code as possible
3353
- AVOID as much as possible using any conditionals within the templates
54+
- Test template rendering with `agentcore add agent` for each framework/protocol combination
3455

3556
## How to use the assets in this directory
3657

37-
- These assets are rendered by the CLI's template renderer in `src/cli/templates/`.
58+
- These assets are rendered by the CLI's template renderer in `src/cli/templates/`
59+
- The `README.md` and `agents/AGENTS.md` are copied verbatim (no template rendering) during project creation
60+
- The `.llm-context/` files are sourced from `src/schema/llm-compacted/` and written during init

src/assets/README.md

Lines changed: 56 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,29 @@ This project was created with the [AgentCore CLI](https://github.com/aws/agentco
55
## Project Structure
66

77
```
8-
.
98
my-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:
3845
agentcore 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

Comments
 (0)