@@ -46,46 +46,54 @@ mcp-agent init [OPTIONS]
4646
4747| Option | Description | Default |
4848| :----- | :---------- | :------ |
49- | ` --name <name> ` | Project name | Current directory name |
50- | ` --template <type> ` | Project template | ` basic ` |
51- | ` --path <dir> ` | Target directory | Current directory |
52- | ` --force ` | Overwrite existing files | ` false ` |
49+ | ` --dir ` , ` -d ` | Target directory | Current directory (` . ` ) |
50+ | ` --template ` , ` -t ` | Project template (scaffolding or example) | ` basic ` |
51+ | ` --quickstart ` | Quickstart mode: copy example only without config files | - |
52+ | ` --force ` , ` -f ` | Overwrite existing files | ` false ` |
53+ | ` --no-gitignore ` | Skip creating .gitignore | ` false ` |
54+ | ` --list ` , ` -l ` | List all available templates | - |
55+
56+ ** Templates:**
57+
58+ Two types of templates are available:
59+ 1 . ** Scaffolding templates** - Create minimal project structure with config files
60+ - ` basic ` - Simple agent with filesystem and fetch
61+ - ` server ` - MCP server with workflow and parallel agents
62+ - ` token ` - Token counting example
63+ - ` factory ` - Agent factory with router-based selection
64+ - ` minimal ` - Config files only
65+
66+ 2 . ** Example templates** - Copy complete example projects
67+ - ` workflow ` - All workflow pattern examples
68+ - ` researcher ` - MCP researcher use case
69+ - ` elicitation ` - MCP elicitation patterns
70+ - ` state-transfer ` - Workflow router example
71+ - ` data-analysis ` - Financial analyzer use case
72+ - ` mcp-basic-agent ` - Basic MCP agent example
73+ - ` token-counter ` - Token counting example
74+ - ` agent-factory ` - Agent factory pattern
75+ - ` basic-agent-server ` - Basic agent server (asyncio)
76+ - ` reference-agent-server ` - Reference agent server implementation
77+ - ` sampling ` - Sampling server example
78+ - ` notifications ` - Notifications server example
5379
5480** Examples:**
5581``` bash
56- # Interactive initialization
57- mcp-agent init
82+ # List all available templates
83+ mcp-agent init --list
5884
59- # With specific template
60- mcp-agent init --template temporal --name research-agent
61- ```
62-
63- ### mcp-agent quickstart
64-
65- Create example projects with pre-built patterns.
66-
67- ``` bash
68- mcp-agent quickstart < TYPE> [OPTIONS]
69- ```
85+ # Create scaffolding project with config files
86+ mcp-agent init --template basic
7087
71- ** Available types:**
72- - ` workflow ` - All workflow pattern examples
73- - ` researcher ` - MCP researcher use case
74- - ` elicitations ` - MCP elicitation patterns
75- - ` state-transfer ` - Workflow router example
76- - ` data-analysis ` - Financial analyzer use case
77- - ` mcp-basic-agent ` - Basic MCP agent example
78- - ` token-counter ` - Token counting example
79- - ` agent-factory ` - Agent factory pattern
80- - ` basic-agent-server ` - Basic agent server (asyncio)
88+ # Copy complete example with config files
89+ mcp-agent init --template workflow --dir ./my-project
8190
82- ** Examples:**
83- ``` bash
84- # Create workflow examples
85- mcp-agent quickstart workflow
91+ # Quickstart mode: copy example only (backward compatible with old 'mcp-agent quickstart')
92+ mcp-agent init --quickstart workflow
93+ # Creates ./workflow/ subdirectory without config files
8694
87- # Create researcher example with force overwrite
88- mcp-agent quickstart researcher --force
95+ # Force overwrite
96+ mcp-agent init -- quickstart researcher --force
8997```
9098
9199### mcp-agent go
@@ -445,7 +453,7 @@ mcp-agent check
445453mcp-agent go --model gpt-4o
446454
447455# Create examples
448- mcp-agent quickstart workflow
456+ mcp-agent init --template workflow
449457```
450458
451459### Cloud Deployment
0 commit comments