Skip to main content

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

FlagDefaultDescription
--timeout <ms>30000Request timeout in milliseconds
--rpcoffInclude raw JSON-RPC logs in JSON output under _rpcLogs
--quietoffSuppress non-result progress output on stderr
--no-telemetryoffDisable anonymous telemetry for this invocation
--format <format>human on TTY, json when pipedRaw output format (json or human)
-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 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

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 inline JSON, @path, or - for stdin
--params <json>Legacy alias for --tool-args
--validate-responseValidate the MCP tool-call envelope returned by the server
--expect-successFail when the tool result reports isError
--reporter <reporter>json-summary or junit-xml validation report output
--debug-out <path>Write debug artifact to file
--uiStart 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

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 inline JSON, @path, or - for stdin
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)
--reporter <reporter>Nojson-summary or junit-xml CI report output

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
--reporter <reporter>Nojson-summary or junit-xml CI report output

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 as JSON, raw string, @path, or - for stdin

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
--reporter <reporter>Nojson-summary or junit-xml CI report output
Use --format json|human for raw output and --reporter json-summary|junit-xml for CI reports.

protocol conformance-suite

FlagRequiredDefaultDescription
--config <path>YesPath to JSON config file
--reporter <reporter>Nojson-summary or junit-xml CI report output

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

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

apps conformance-suite

FlagRequiredDefaultDescription
--config <path>YesPath to JSON config file
--reporter <reporter>Nojson-summary or junit-xml CI report output

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

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

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