Skip to main content

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

FlagDefaultDescription
--timeout <ms>30000Request timeout in milliseconds
--rpcoffInclude raw JSON-RPC logs in JSON output under _rpcLogs
--format <format>human on TTY, json when pipedOutput format (json or human; junit-xml is available on protocol, OAuth, and apps conformance commands)
-v, --versionPrint the CLI version

server commands

All server commands accept the shared connection flags below, plus command-specific options.

Shared connection flags

FlagDescription
--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

FlagDescription
--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.

tools commands

tools list

Uses shared connection flags.

tools call

FlagDescription
--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

FlagDescription
--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

FlagDescription
--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

FlagRequiredDefaultDescription
--url <url>YesMCP server URL
--protocol-version <v>Yes2025-03-26, 2025-06-18, or 2025-11-25
--registration <s>Yescimd, dcr, or preregistered
--auth-mode <m>Nointeractiveheadless, interactive, or client_credentials
--client-id <id>NoOAuth client ID
--client-secret <s>NoOAuth client secret
--client-metadata-url <url>NoCIMD metadata document URL
--redirect-url <url>NoAuto-generatedOAuth redirect URL
--scopes <scopes>NoSpace-separated scope string
--header <header>NoHTTP header Key: Value (repeatable)
--step-timeout <ms>No30000Per-step timeout
--verify-toolsNoAfter login, list tools
--verify-call-tool <name>NoAlso call the named tool
--credentials-out <path>NoWrite OAuth credentials to file (mode 0600); stdout has secrets redacted
--debug-out <path>NoWrite debug artifact to file

oauth conformance

FlagRequiredDefaultDescription
--url <url>YesMCP server URL
--protocol-version <v>Yes2025-03-26, 2025-06-18, or 2025-11-25
--registration <s>Yescimd, dcr, or preregistered
--auth-mode <m>Nointeractiveheadless, interactive, or client_credentials
--client-id <id>NoOAuth client ID
--client-secret <s>NoOAuth client secret
--client-metadata-url <url>NoCIMD metadata document URL
--redirect-url <url>NoAuto-generatedOAuth redirect URL
--scopes <scopes>NoSpace-separated scope string
--header <header>NoHTTP header Key: Value (repeatable)
--step-timeout <ms>No30000Per-step timeout
--verify-toolsNoAfter OAuth, list tools
--verify-call-tool <name>NoAlso call the named tool
--conformance-checksNoRun additional negative OAuth checks, including DCR redirect URI policy and redirect-mismatch probes
--print-urlNoPrint consent URL to stderr (interactive only)

oauth conformance-suite

FlagRequiredDefaultDescription
--config <path>YesPath to JSON config file
--verify-toolsNoEnable tool listing on all flows
--verify-call-tool <name>NoCall the named tool after listing

oauth metadata

FlagRequiredDescription
--url <url>YesOAuth metadata URL to fetch

oauth proxy / oauth debug-proxy

FlagRequiredDefaultDescription
--url <url>YesOAuth request URL
--method <method>NoGETHTTP method
--header <header>NoHTTP header Key: Value (repeatable)
--body <value>NoRequest body (JSON or raw string)

protocol commands

protocol conformance

FlagRequiredDefaultDescription
--url <url>YesMCP server URL
--access-token <token>NoBearer access token
--credentials-file <path>NoLoad OAuth credentials from a file created by oauth login --credentials-out
--header <header>NoHTTP header Key: Value (repeatable)
--check-timeout <ms>No15000Per-check timeout in milliseconds
--category <category>NoallRestrict checks to one or more categories
--check-id <id>NoallRestrict checks to one or more check IDs
Supports --format json, --format human, and --format junit-xml.

protocol conformance-suite

FlagRequiredDefaultDescription
--config <path>YesPath to JSON config file
--format <fmt>NoAuto-detectedjson, human, or junit-xml

apps commands

Shared connection flags

FlagDescription
--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.

apps conformance

MCP Apps server-side conformance checks. Uses shared connection flags plus:
FlagDescription
--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.

apps conformance-suite

FlagRequiredDefaultDescription
--config <path>YesPath to JSON config file
--format <fmt>NoAuto-detectedjson, human, or junit-xml

apps debug

Execute one MCP App tool and optionally render the result in the local Inspector App Builder.
FlagRequiredDescription
--tool-name <name>YesTool name to execute
--params <json-or-@file>NoTool parameters as JSON or @path to a JSON file
--uiNoStart or attach to Inspector and render the result in App Builder
--inspector-url <url>NoLocal Inspector base URL
--server-name <name>NoServer name to use inside Inspector
--protocol <protocol>NoRender protocol: mcp-apps or openai-sdk
--device <device>NoRender device: mobile, tablet, desktop, or custom
--theme <theme>NoRender theme: light or dark
--locale <locale>NoRender locale
--time-zone <iana>NoRender IANA timezone
--out <path>NoWrite the full debug artifact to a JSON file
--retries <count>NoRetry transient failures this many times
--retry-delay-ms <ms>NoFixed 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.

apps mcp-widget

Fetch hosted-style MCP App widget content.
FlagRequiredDescription
--resource-uri <uri>YesWidget resource URI
--tool-id <id>YesTool call ID used for runtime injection
--tool-name <name>YesTool name used for runtime injection
--tool-input <json>NoTool input payload as JSON
--tool-output <json>NoTool output payload as JSON
--theme <theme>NoWidget theme: light or dark
--csp-mode <mode>NoCSP mode: permissive or widget-declared
--template <uri>NoOptional ui:// template override
--view-mode <mode>NoWidget view mode
--view-params <json>NoWidget view params as JSON
Plus shared connection flags.

apps chatgpt-widget

Fetch hosted-style ChatGPT App widget content.
FlagRequiredDescription
--resource-uri <uri>YesWidget resource URI
--tool-id <id>YesTool call ID used for runtime injection
--tool-name <name>YesTool name used for runtime injection
--tool-input <json>NoTool input payload as JSON
--tool-output <json>NoTool output payload as JSON
--tool-response-metadata <json>NoTool response metadata as a JSON object
--theme <theme>NoWidget theme: light or dark
--csp-mode <mode>NoCSP mode: permissive or widget-declared
--locale <locale>NoLocale override
--device-type <type>NoDevice type: mobile, tablet, or desktop
Plus shared connection flags.

inspector commands

inspector open

Start or attach to the local Inspector and open the UI.
FlagRequiredDescription
--inspector-url <url>NoLocal Inspector base URL
--tab <tab>NoOpen Inspector on a specific tab

inspector start

Start the local Inspector in the background without opening a browser.
FlagRequiredDescription
--inspector-url <url>NoLocal Inspector base URL

inspector stop

Stop the local Inspector if it is running.
FlagRequiredDescription
--inspector-url <url>NoLocal Inspector base URL

Exit codes

CodeMeaning
0Success / all checks passed
1Command ran but reported a failure
2Invalid arguments or configuration