Skip to main content

GUIDE

Constant GUIDE 

Source
pub const GUIDE: &str = "# cargo-pmcp CLI Guide\n\n`cargo pmcp` is the developer CLI for PMCP SDK projects. It provides\nscaffolding, testing, previewing, and deployment commands.\n\n## Commands\n\n### init / scaffold\n\nCreate a new PMCP workspace or add components:\n\n```bash\ncargo pmcp init my-server          # New workspace with server template\ncargo pmcp scaffold tool greet     # Add a tool to existing server\ncargo pmcp scaffold resource docs  # Add a resource handler\n```\n\n### test\n\nRun protocol compliance and validation tests:\n\n```bash\ncargo pmcp test check <url>        # Protocol compliance against a running server\ncargo pmcp test run <url>          # Run test scenarios\ncargo pmcp test generate <url>     # Auto-generate test scenarios from server listing\ncargo pmcp test apps <url>         # Validate MCP Apps metadata and widgets\n```\n\n### preview\n\nLaunch an interactive browser preview for MCP Apps:\n\n```bash\ncargo pmcp preview <url>           # Open widget preview for a server\ncargo pmcp preview <url> --chatgpt # Preview in ChatGPT compatibility mode\n```\n\n### schema\n\nExport tool schemas:\n\n```bash\ncargo pmcp schema export <url>     # Export schemas as JSON\ncargo pmcp schema diff <url>       # Compare schemas between versions\n```\n\n### validate\n\nValidate server configuration and manifests:\n\n```bash\ncargo pmcp validate                # Validate current project\ncargo pmcp validate --strict       # Strict mode with additional checks\n```\n\n### deploy\n\nDeploy to hosted infrastructure:\n\n```bash\ncargo pmcp deploy                  # Deploy current server\ncargo pmcp deploy --server <name>  # Deploy to named server\n```\n\n### secret\n\nManage deployment secrets:\n\n```bash\ncargo pmcp secret set KEY=VALUE    # Set a secret\ncargo pmcp secret list             # List configured secrets\n```\n\n### connect\n\nConnect to a remote MCP server for inspection:\n\n```bash\ncargo pmcp connect <url>           # Interactive connection to server\n```\n\n## Global Flags\n\n```\n--verbose, -v    Enable verbose output\n--quiet, -q      Suppress non-essential output\n--no-color       Disable colored output\n--format <fmt>   Output format: text (default), json, yaml\n```\n\n## Environment Variables\n\n| Variable         | Purpose                          |\n|------------------|----------------------------------|\n| PMCP_QUIET       | Suppress output (same as --quiet)|\n| NO_COLOR         | Disable colors (same as --no-color)|\n| PMCP_SERVER_URL  | Default server URL               |\n| PMCP_API_KEY     | API key for authenticated servers|\n";
Expand description

Complete cargo-pmcp CLI reference.