Skip to content

Commit 20288a3

Browse files
committed
merge init and quickstart
1 parent 414673d commit 20288a3

File tree

5 files changed

+257
-302
lines changed

5 files changed

+257
-302
lines changed

docs/cli-reference.mdx

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -45,46 +45,54 @@ mcp-agent init [OPTIONS]
4545

4646
| Option | Description | Default |
4747
| :----- | :---------- | :------ |
48-
| `--name <name>` | Project name | Current directory name |
49-
| `--template <type>` | Project template | `basic` |
50-
| `--path <dir>` | Target directory | Current directory |
51-
| `--force` | Overwrite existing files | `false` |
48+
| `--dir`, `-d` | Target directory | Current directory (`.`) |
49+
| `--template`, `-t` | Project template (scaffolding or example) | `basic` |
50+
| `--quickstart` | Quickstart mode: copy example only without config files | - |
51+
| `--force`, `-f` | Overwrite existing files | `false` |
52+
| `--no-gitignore` | Skip creating .gitignore | `false` |
53+
| `--list`, `-l` | List all available templates | - |
54+
55+
**Templates:**
56+
57+
Two types of templates are available:
58+
1. **Scaffolding templates** - Create minimal project structure with config files
59+
- `basic` - Simple agent with filesystem and fetch
60+
- `server` - MCP server with workflow and parallel agents
61+
- `token` - Token counting example
62+
- `factory` - Agent factory with router-based selection
63+
- `minimal` - Config files only
64+
65+
2. **Example templates** - Copy complete example projects
66+
- `workflow` - All workflow pattern examples
67+
- `researcher` - MCP researcher use case
68+
- `elicitation` - MCP elicitation patterns
69+
- `state-transfer` - Workflow router example
70+
- `data-analysis` - Financial analyzer use case
71+
- `mcp-basic-agent` - Basic MCP agent example
72+
- `token-counter` - Token counting example
73+
- `agent-factory` - Agent factory pattern
74+
- `basic-agent-server` - Basic agent server (asyncio)
75+
- `reference-agent-server` - Reference agent server implementation
76+
- `sampling` - Sampling server example
77+
- `notifications` - Notifications server example
5278

5379
**Examples:**
5480
```bash
55-
# Interactive initialization
56-
mcp-agent init
81+
# List all available templates
82+
mcp-agent init --list
5783

58-
# With specific template
59-
mcp-agent init --template temporal --name research-agent
60-
```
61-
62-
### mcp-agent quickstart
63-
64-
Create example projects with pre-built patterns.
65-
66-
```bash
67-
mcp-agent quickstart <TYPE> [OPTIONS]
68-
```
84+
# Create scaffolding project with config files
85+
mcp-agent init --template basic
6986

70-
**Available types:**
71-
- `workflow` - All workflow pattern examples
72-
- `researcher` - MCP researcher use case
73-
- `elicitations` - MCP elicitation patterns
74-
- `state-transfer` - Workflow router example
75-
- `data-analysis` - Financial analyzer use case
76-
- `mcp-basic-agent` - Basic MCP agent example
77-
- `token-counter` - Token counting example
78-
- `agent-factory` - Agent factory pattern
79-
- `basic-agent-server` - Basic agent server (asyncio)
87+
# Copy complete example with config files
88+
mcp-agent init --template workflow --dir ./my-project
8089

81-
**Examples:**
82-
```bash
83-
# Create workflow examples
84-
mcp-agent quickstart workflow
90+
# Quickstart mode: copy example only (backward compatible with old 'mcp-agent quickstart')
91+
mcp-agent init --quickstart workflow
92+
# Creates ./workflow/ subdirectory without config files
8593

86-
# Create researcher example with force overwrite
87-
mcp-agent quickstart researcher --force
94+
# Force overwrite
95+
mcp-agent init --quickstart researcher --force
8896
```
8997

9098
### mcp-agent go
@@ -444,7 +452,7 @@ mcp-agent check
444452
mcp-agent go --model gpt-4o
445453

446454
# Create examples
447-
mcp-agent quickstart workflow
455+
mcp-agent init --quickstart workflow
448456
```
449457

450458
### Cloud Deployment

src/mcp_agent/cli/commands/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
invoke,
1212
serve,
1313
init,
14-
quickstart,
1514
config,
1615
keys,
1716
models,
@@ -31,7 +30,6 @@
3130
"invoke",
3231
"serve",
3332
"init",
34-
"quickstart",
3533
"config",
3634
"keys",
3735
"models",

0 commit comments

Comments
 (0)