Documentation Index
Fetch the complete documentation index at: https://mcpjam-mintlify-docs-update-pr-1946-1777273189104.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Complete flag tables for every mcpjam command. For guides and recipes, see the individual command pages.
Global flags
| Flag | Default | Description |
|---|
--timeout <ms> | 30000 | Request timeout in milliseconds |
--rpc | off | Include raw JSON-RPC logs in JSON output under _rpcLogs |
--format <format> | human on TTY, json when piped | Output format (json or human; junit-xml is available on protocol, OAuth, and apps conformance commands) |
-v, --version | | Print the CLI version |
server commands
All server commands accept the shared connection flags below, plus command-specific options.
Shared connection flags
| Flag | Description |
|---|
--transport <transport> | Explicit transport type (http or stdio) |
--url <url> | HTTP MCP server URL |
--access-token <token> | Bearer access token |
--oauth-access-token <token> | OAuth bearer access token |
--refresh-token <token> | OAuth refresh token |
--client-id <id> | OAuth client ID (with --refresh-token) |
--client-secret <secret> | OAuth client secret (with --refresh-token) |
--credentials-file <path> | Load OAuth credentials from a file created by oauth login --credentials-out |
--header <header> | HTTP header Key: Value (repeatable) |
--client-capabilities <json> | Client capabilities JSON object |
--command <command> | Stdio server command |
--args <arg...> | Preferred stdio command arguments |
--command-args <arg> | Legacy stdio command argument (repeatable) |
-e, --env <env...> | Stdio environment KEY=VALUE values |
--cwd <path> | Working directory for the stdio child process |
Transport selection is inferred from --url vs --command when
--transport is omitted. Use --transport http|stdio when you want an
explicit validation step.
For stdio targets, child processes inherit the parent shell environment by
default. -e/--env adds or overrides child env values, and structured debug
artifacts only record the explicit env keys you passed on the command line.
--credentials-file cannot be combined with individual token flags
(--access-token, --oauth-access-token, --refresh-token, --client-id,
--client-secret). The CLI rejects conflicting auth sources upfront.
server probe
No additional flags beyond shared connection flags.
server doctor
| Flag | Description |
|---|
--out <path> | Write the doctor JSON artifact to a file |
server info
No additional flags.
server validate
No additional flags.
server ping
No additional flags.
server capabilities
No additional flags.
server export
No additional flags.
Uses shared connection flags.
| Flag | Description |
|---|
--tool-name <name> | Name of the tool to call |
--name <name> | Legacy alias for --tool-name |
--tool-args <json> | Tool arguments as a JSON string |
--params <json> | Legacy alias for --tool-args |
--debug-out <path> | Write debug artifact to file |
Plus shared connection flags.
resources commands
resources list
Uses shared connection flags.
resources read
| Flag | Description |
|---|
--resource-uri <uri> | URI of the resource to read |
--uri <uri> | Legacy alias for --resource-uri |
Plus shared connection flags.
resources templates
Uses shared connection flags.
prompts commands
prompts list
Uses shared connection flags.
prompts get
| Flag | Description |
|---|
--prompt-name <name> | Name of the prompt |
--name <name> | Legacy alias for --prompt-name |
--prompt-args <json> | Prompt arguments as a JSON string |
Plus shared connection flags.
oauth commands
oauth login
| Flag | Required | Default | Description |
|---|
--url <url> | Yes | | MCP server URL |
--protocol-version <v> | Yes | | 2025-03-26, 2025-06-18, or 2025-11-25 |
--registration <s> | Yes | | cimd, dcr, or preregistered |
--auth-mode <m> | No | interactive | headless, interactive, or client_credentials |
--client-id <id> | No | | OAuth client ID |
--client-secret <s> | No | | OAuth client secret |
--client-metadata-url <url> | No | | CIMD metadata document URL |
--redirect-url <url> | No | Auto-generated | OAuth redirect URL |
--scopes <scopes> | No | | Space-separated scope string |
--header <header> | No | | HTTP header Key: Value (repeatable) |
--step-timeout <ms> | No | 30000 | Per-step timeout |
--verify-tools | No | | After login, list tools |
--verify-call-tool <name> | No | | Also call the named tool |
--credentials-out <path> | No | | Write OAuth credentials to file (mode 0600); stdout has secrets redacted |
--debug-out <path> | No | | Write debug artifact to file |
| Flag | Required | Default | Description |
|---|
--url <url> | Yes | | MCP server URL |
--protocol-version <v> | Yes | | 2025-03-26, 2025-06-18, or 2025-11-25 |
--registration <s> | Yes | | cimd, dcr, or preregistered |
--auth-mode <m> | No | interactive | headless, interactive, or client_credentials |
--client-id <id> | No | | OAuth client ID |
--client-secret <s> | No | | OAuth client secret |
--client-metadata-url <url> | No | | CIMD metadata document URL |
--redirect-url <url> | No | Auto-generated | OAuth redirect URL |
--scopes <scopes> | No | | Space-separated scope string |
--header <header> | No | | HTTP header Key: Value (repeatable) |
--step-timeout <ms> | No | 30000 | Per-step timeout |
--verify-tools | No | | After OAuth, list tools |
--verify-call-tool <name> | No | | Also call the named tool |
--conformance-checks | No | | Run additional negative OAuth checks, including DCR redirect URI policy and redirect-mismatch probes |
--print-url | No | | Print consent URL to stderr (interactive only) |
| Flag | Required | Default | Description |
|---|
--config <path> | Yes | | Path to JSON config file |
--verify-tools | No | | Enable tool listing on all flows |
--verify-call-tool <name> | No | | Call the named tool after listing |
| Flag | Required | Description |
|---|
--url <url> | Yes | OAuth metadata URL to fetch |
oauth proxy / oauth debug-proxy
| Flag | Required | Default | Description |
|---|
--url <url> | Yes | | OAuth request URL |
--method <method> | No | GET | HTTP method |
--header <header> | No | | HTTP header Key: Value (repeatable) |
--body <value> | No | | Request body (JSON or raw string) |
protocol commands
| Flag | Required | Default | Description |
|---|
--url <url> | Yes | | MCP server URL |
--access-token <token> | No | | Bearer access token |
--credentials-file <path> | No | | Load OAuth credentials from a file created by oauth login --credentials-out |
--header <header> | No | | HTTP header Key: Value (repeatable) |
--check-timeout <ms> | No | 15000 | Per-check timeout in milliseconds |
--category <category> | No | all | Restrict checks to one or more categories |
--check-id <id> | No | all | Restrict checks to one or more check IDs |
Supports --format json, --format human, and --format junit-xml.
| Flag | Required | Default | Description |
|---|
--config <path> | Yes | | Path to JSON config file |
--format <fmt> | No | Auto-detected | json, human, or junit-xml |
apps commands
Shared connection flags
| Flag | Description |
|---|
--transport <transport> | Explicit transport type (http or stdio) |
--url <url> | HTTP MCP server URL |
--access-token <token> | Bearer access token |
--oauth-access-token <token> | OAuth bearer access token |
--refresh-token <token> | OAuth refresh token |
--client-id <id> | OAuth client ID (with --refresh-token) |
--client-secret <secret> | OAuth client secret (with --refresh-token) |
--credentials-file <path> | Load OAuth credentials from a file created by oauth login --credentials-out |
--header <header> | HTTP header Key: Value (repeatable) |
--client-capabilities <json> | Client capabilities JSON object |
--command <command> | Stdio server command |
--args <arg...> | Preferred stdio command arguments |
--command-args <arg> | Legacy stdio command argument (repeatable) |
-e, --env <env...> | Stdio environment KEY=VALUE values |
--cwd <path> | Working directory for the stdio child process |
Apps commands share the same transport inference rules as the rest of the CLI:
--url implies HTTP, --command implies stdio, and --transport is an
optional explicit override.
MCP Apps server-side conformance checks. Uses shared connection flags plus:
| Flag | Description |
|---|
--category <category> | Check category to run (tools, resources). Repeatable |
--check-id <id> | Specific check id to run. Repeatable |
Supports --format json, --format human, and --format junit-xml.
| Flag | Required | Default | Description |
|---|
--config <path> | Yes | | Path to JSON config file |
--format <fmt> | No | Auto-detected | json, human, or junit-xml |
apps debug
Execute one MCP App tool and optionally render the result in the local Inspector App Builder.
| Flag | Required | Description |
|---|
--tool-name <name> | Yes | Tool name to execute |
--params <json-or-@file> | No | Tool parameters as JSON or @path to a JSON file |
--ui | No | Start or attach to Inspector and render the result in App Builder |
--inspector-url <url> | No | Local Inspector base URL |
--server-name <name> | No | Server name to use inside Inspector |
--protocol <protocol> | No | Render protocol: mcp-apps or openai-sdk |
--device <device> | No | Render device: mobile, tablet, desktop, or custom |
--theme <theme> | No | Render theme: light or dark |
--locale <locale> | No | Render locale |
--time-zone <iana> | No | Render IANA timezone |
--out <path> | No | Write the full debug artifact to a JSON file |
--retries <count> | No | Retry transient failures this many times |
--retry-delay-ms <ms> | No | Fixed delay between retries in milliseconds |
Plus shared connection flags.
With --ui, execution is the server tool result and inspectorRender is UI render evidence. The UI path injects the completed tool result and does not call the tool a second time.
Fetch hosted-style MCP App widget content.
| Flag | Required | Description |
|---|
--resource-uri <uri> | Yes | Widget resource URI |
--tool-id <id> | Yes | Tool call ID used for runtime injection |
--tool-name <name> | Yes | Tool name used for runtime injection |
--tool-input <json> | No | Tool input payload as JSON |
--tool-output <json> | No | Tool output payload as JSON |
--theme <theme> | No | Widget theme: light or dark |
--csp-mode <mode> | No | CSP mode: permissive or widget-declared |
--template <uri> | No | Optional ui:// template override |
--view-mode <mode> | No | Widget view mode |
--view-params <json> | No | Widget view params as JSON |
Plus shared connection flags.
Fetch hosted-style ChatGPT App widget content.
| Flag | Required | Description |
|---|
--resource-uri <uri> | Yes | Widget resource URI |
--tool-id <id> | Yes | Tool call ID used for runtime injection |
--tool-name <name> | Yes | Tool name used for runtime injection |
--tool-input <json> | No | Tool input payload as JSON |
--tool-output <json> | No | Tool output payload as JSON |
--tool-response-metadata <json> | No | Tool response metadata as a JSON object |
--theme <theme> | No | Widget theme: light or dark |
--csp-mode <mode> | No | CSP mode: permissive or widget-declared |
--locale <locale> | No | Locale override |
--device-type <type> | No | Device type: mobile, tablet, or desktop |
Plus shared connection flags.
inspector commands
inspector open
Start or attach to the local Inspector and open the UI.
| Flag | Required | Description |
|---|
--inspector-url <url> | No | Local Inspector base URL |
--tab <tab> | No | Open Inspector on a specific tab |
inspector start
Start the local Inspector in the background without opening a browser.
| Flag | Required | Description |
|---|
--inspector-url <url> | No | Local Inspector base URL |
inspector stop
Stop the local Inspector if it is running.
| Flag | Required | Description |
|---|
--inspector-url <url> | No | Local Inspector base URL |
Exit codes
| Code | Meaning |
|---|
0 | Success / all checks passed |
1 | Command ran but reported a failure |
2 | Invalid arguments or configuration |