Documentation Index
Fetch the complete documentation index at: https://mcpjam-mintlify-docs-update-pr-1958-1777325861850.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 |
--quiet | off | Suppress non-result progress output on stderr |
--no-telemetry | off | Disable anonymous telemetry for this invocation |
--format <format> | human on TTY, json when piped | Raw output format (json or human) |
-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 as inline JSON, @path, or - for stdin |
--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 inline JSON, @path, or - for stdin |
--params <json> | Legacy alias for --tool-args |
--validate-response | Validate the MCP tool-call envelope returned by the server |
--expect-success | Fail when the tool result reports isError |
--reporter <reporter> | json-summary or junit-xml validation report output |
--debug-out <path> | Write debug artifact to file |
--ui | Start or attach to Inspector and render the completed tool result in App Builder |
--inspector-url <url> | Local Inspector base URL |
--server-name <name> | Server name to use inside Inspector |
--protocol <protocol> | Render protocol: mcp-apps or openai-sdk |
--device <device> | Render device: mobile, tablet, desktop, or custom |
--theme <theme> | Render theme: light or dark |
--locale <locale> | Render locale |
--time-zone <iana> | Render IANA timezone |
Plus shared connection flags.
Without --ui, tools call returns the raw tool result. With --ui, it returns an envelope with result and inspectorRender. The Inspector path injects the completed tool result through renderToolResult; it does not call the tool a second time. --ui cannot be combined with --reporter.
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 inline JSON, @path, or - for stdin |
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) |
--reporter <reporter> | No | | json-summary or junit-xml CI report output |
| 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 |
--reporter <reporter> | No | | json-summary or junit-xml CI report output |
| 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 as JSON, raw string, @path, or - for stdin |
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 |
--reporter <reporter> | No | | json-summary or junit-xml CI report output |
Use --format json|human for raw output and --reporter json-summary|junit-xml for CI reports.
| Flag | Required | Default | Description |
|---|
--config <path> | Yes | | Path to JSON config file |
--reporter <reporter> | No | | json-summary or junit-xml CI report output |
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 as inline JSON, @path, or - for stdin |
--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 |
--reporter <reporter> | json-summary or junit-xml CI report output |
Use --format json|human for raw output and --reporter json-summary|junit-xml for CI reports.
| Flag | Required | Default | Description |
|---|
--config <path> | Yes | | Path to JSON config file |
--reporter <reporter> | No | | json-summary or junit-xml CI report output |
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 |
telemetry commands
Telemetry commands inspect and configure anonymous CLI telemetry. They never emit telemetry events themselves.
telemetry status
Shows the effective telemetry state, install ID state, state file path, debug mode, and disable reason when disabled. This command does not create an install ID.
telemetry disable
Persistently disables anonymous CLI telemetry by writing enabled: false to the telemetry state file. If no install ID exists yet, this command does not create one.
telemetry enable
Persistently enables anonymous CLI telemetry. If no install ID exists yet, this command creates a random install UUID.
Exit codes
| Code | Meaning |
|---|
0 | Success / all checks passed |
1 | Command ran but reported a failure |
2 | Invalid arguments or configuration |