Skip to main content
每次 CLI 运行都会连接到服务器,调用你通过 --method 指定的单个请求,打印结果,然后退出。这使其非常适合 CI 流水线、Shell 单行命令,以及需要立即验证服务器更改的编程代理。
下面的示例使用已安装的 mcp-inspector 二进制文件。如果未进行全局安装,请像上面一样,在每条命令前加上 npx @modelcontextprotocol/inspector

选择服务器

CLI 接受位置参数命令(stdio)、--server-url(HTTP/SSE),或从目录或配置文件中选择命名服务器:
当服务器来自文件时,其每个服务器的设置(请求头、超时、OAuth、协议时代和根目录)将应用于连接,其解析方式与 TUI 和 Web 客户端完全一致。--header 标志会在本次运行中覆盖文件中的请求头,同时保留其中的超时和 OAuth 设置。 后续示例会将你所使用的上述任一种形式,以及其 --transport--config/--server 标志,统称为 <server>
**配置文件是为运行提供 根目录的唯一持久方式:**没有 roots 标志,并且 --method roots/set 仅适用于该次短暂连接。为服务器配置的根目录会在连接时公布,因此调用 roots/list 的服务器(例如 @modelcontextprotocol/server-filesystem,它会通过此调用了解其允许访问的目录)可以获取这些根目录。
请参阅配置和标志,了解 --catalog--config-- 分隔符以及通用服务器选择标志。

方法

仅限流或会话的方法(例如 logging/tail)会被拒绝,因为退出的进程无法保持流处于打开状态。

传递参数

--tool-arg 接受 key=value,并通过 JSON 解析来强制转换值,因此 count=1 会变成数字,而 "012" 会变成 12
--tool-args-json 一次性接受完整的参数对象,并原样传递,不进行强制转换,因此 "012" 会保持为字符串 012。两者不能同时使用:

输出

--format text(默认)以适合人类阅读的格式美化输出。--format json 会在 stdout 上输出单个 JSON 对象,不包含任何横幅信息,因此整个输出可以直接通过管道传递:

探测 MCP 应用

--app-info 会报告某个工具是否提供 MCP 应用 UI(包括其 ui:// 资源、CSP 和权限),而不会调用该工具,因此流水线可以在调用任何工具之前决定是否需要浏览器:
退出代码用于区分不同结果:提供应用的工具退出码为 0,不提供应用的工具退出码为 2,缺少的工具退出码为 5,因此拼写错误不会被误认为“没有应用”。探测失败(UI 资源无法读取、resourceUri 格式错误)会记录在 resourceError 字段中,而不会中止操作,因此单个异常工具不会导致整个列表处理失败。
tools/list --app-info 始终输出 NDJSON(每个工具一行),无论 --format 的值是什么;--format json 只会调整 tools/call --app-info 的单个工具输出格式。

退出代码和错误信封

每个非零退出代码都对应一个稳定的失败类别,因此调用方无需抓取文字描述即可根据_原因_进行分支处理: 在任何非零退出的情况下,CLI 还会向 stderr 写入一行 JSON
由于它只有一行,调用方可以使用 2>&1 | tail -1 | jq .error 对其进行解析。 返回 isError: truetools/call 仍会打印其载荷,但会以 5 退出,因此 && 链不会在调用失败时继续执行。

脚本中的授权

默认情况下,CLI 运行与 TUI 相同的回环 OAuth 流程:打开浏览器并等待 localhost 回调,而 CI 作业无法完成此操作。以下两个标志可让非交互式运行变得可预测:
  • --stored-auth-only:永不启动交互式 OAuth 或升级验证,也永不自动打开浏览器。如果共享存储中存在令牌,则使用这些令牌;否则立即失败并返回 auth_required。这是 CI 所需的标志。
  • --use-stored-auth:复用 Web Inspector 已在此机器上获取的令牌;如果存储了刷新令牌,则会先刷新令牌。
如果两个标志都未使用,且 stdin 或 stderr 上没有 TTY,CLI 会快速失败并返回 auth_required,而不是在无人完成的回调上挂起十五分钟。 完整流程、Web 到 CLI 的交接以及 --print-handoff,请参阅授权

配方

在 CI 中验证服务器

根据失败类别进行分支处理

对所有具有 UI 的工具执行冒烟测试

在不建立连接的情况下检查目录

servers/show 会隐藏包含机密信息的字段(env 值、敏感请求头、 OAuth 客户端机密),但不会清除嵌入服务器 url(用户信息或查询令牌)或 stdio args 中的凭据。在将原始 URL 和 detail 字段粘贴到 issue 之前,请将其视为敏感信息。

代理

连接到远程 HTTP/SSE 服务器时,会遵循约定的代理变量:HTTPS_PROXY / HTTP_PROXY(及其小写形式)用于选择代理,NO_PROXY 用于排除特定主机。无需设置 Inspector 专用标志,并且代理代理器会延迟加载,因此不使用代理时不会产生任何开销。Web 客户端的后端同样如此。