Run Command¶
The run
command starts MCP server templates with specific transport and configuration options.
Usage¶
Options¶
Transport Options¶
--transport {http,stdio}
: Choose transport method (default: stdio)--port PORT
: Port number for HTTP transport (default: 3000)
Directory Options¶
--data-dir DATA_DIR
: Directory for persistent data storage--config-dir CONFIG_DIR
: Directory for configuration files
General Options¶
-h, --help
: Show help message and exit
Transport Methods¶
STDIO Transport¶
The default transport method using standard input/output:
Use cases: - Direct integration with MCP clients - Process-to-process communication - Local development and testing
HTTP Transport¶
HTTP-based transport for web integration:
Use cases: - Web service integration - Remote access to MCP servers - API-style interactions
Configuration¶
Data Directory¶
Specify where template data is stored:
Config Directory¶
Set configuration file location:
Examples¶
Run with default settings (STDIO):
Run HTTP server on port 8080:
Run with custom directories:
Full configuration example:
Prerequisites¶
- Template must be properly configured
- Required ports must be available (for HTTP transport)
- Data and config directories must be accessible
Related Commands¶
deploy
- Deploy templates for containerized runninginteractive
- Interactive mode with enhanced tool accessconfig
- Configure template settings