关键词

MCP服务器管理服务器部署上下文服务工具链Smithery

Smithery CLI 使用说明

项目简介

Smithery CLI 是一个命令行工具，用于安装、管理和运行基于 Model Context Protocol (MCP) 的服务器。它作为一个客户端无关的工具，可以帮助用户轻松地将 MCP 服务器集成到不同的 AI 客户端环境中。通过 Smithery CLI，您可以方便地从 Smithery Registry 安装和管理各种 MCP 服务器，并配置它们以供您的 LLM 应用使用。

主要功能点

  • 服务器安装与卸载: 从 Smithery Registry 安装和卸载 MCP 服务器，支持指定 AI 客户端。
  • 服务器配置管理: 支持通过命令行配置服务器，或使用预先配置的 JSON 数据跳过交互式配置。
  • 服务器运行与监控: 运行已安装的 MCP 服务器，并提供交互式检查服务器状态的功能。
  • 客户端列表: 列出当前支持的 AI 客户端。
  • 详细日志: 提供详细的日志输出，方便调试和问题排查。

安装步骤

Smithery CLI 通过 npm 包管理器发布，需要 Node.js 环境（版本 18 或以上）。

  1. 安装 Smithery CLI:

    在命令行终端中，使用 npm 或 npx 命令全局安装 '@smithery/cli' 包：

    npm install -g @smithery/cli

    或者，您可以使用 'npx' 直接运行命令，而无需全局安装：

    npx @smithery/cli --help

  2. 查看帮助信息:

    安装完成后，您可以运行以下命令查看可用的命令和选项：

    smithery --help

    或者使用 'npx'：

    npx @smithery/cli --help

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令才能连接。Smithery CLI 简化了这一过程，您无需手动编写复杂的配置，只需使用 'install' 命令即可自动完成配置。

以下是 MCP 客户端可能需要配置的关键信息（JSON 格式示例，不需要手动配置，由 Smithery CLI 自动处理）：

{
  "mcpServers": {
    "mcp-obsidian": {  // server name，例如您安装的服务器 ID
      "command": "npx", // 启动服务器的命令，通常是 npx
      "args": [        // 传递给命令的参数
        "-y",
        "@smithery/cli@latest", // 确保使用最新版本的 @smithery/cli
        "run",                 // 运行命令
        "mcp-obsidian",       // 要运行的服务器 ID
        "--config",            // 传递配置参数
        "\"{\\\"vaultPath\\\":\\\"path/to/vault\\\"}\"" // JSON 格式的服务器配置，例如 Obsidian vault 路径，**此部分通常由 Smithery CLI 自动生成或交互式配置**
      ]
    }
  }
}

参数注释:

  • 'mcpServers': 包含所有已配置 MCP 服务器的对象。
  • 'mcp-obsidian': 服务器的唯一标识符，这里以 'mcp-obsidian' 为例。
  • 'command': 用于启动服务器进程的命令，通常设置为 'npx'，用于执行 npm 包。
  • 'args': 传递给 'command' 的参数数组，包括：
    • '-y': 'npx' 参数，自动确认安装包。
    • '@smithery/cli@latest': 指定使用的 npm 包为 '@smithery/cli' 最新版本。
    • 'run': '@smithery/cli' 的子命令，用于运行 MCP 服务器。
    • 'mcp-obsidian': 要运行的 MCP 服务器的 ID。
    • '--config': 指定服务器配置的参数。
    • '"{\"vaultPath\":\"path/to/vault\"}"': JSON 格式的服务器配置数据，例如设置 Obsidian vault 的路径。请注意，实际配置内容会根据不同的 MCP 服务器而变化，通常通过 Smithery CLI 的 'install' 命令进行配置。

重要提示: 您通常不需要手动编辑或创建上述 JSON 配置。 Smithery CLI 会自动处理服务器的安装、配置和启动命令生成。您只需要使用 CLI 提供的命令即可。

基本使用方法

  1. 安装 MCP 服务器:

    使用 'install' 命令安装 MCP 服务器。必须指定 '--client' 参数，指示您要为哪个 AI 客户端安装服务器。例如，为 'claude' 客户端安装 'mcp-obsidian' 服务器：

    npx @smithery/cli install mcp-obsidian --client claude

    如果服务器需要配置信息，CLI 将会提示您进行交互式配置。

  2. 安装带预配置数据的服务器:

    您可以使用 '--config' 参数在安装时提供 JSON 格式的配置数据，跳过交互式配置提示。例如：

    npx @smithery/cli install mcp-obsidian --client claude --config '{"vaultPath":"path/to/vault"}'

  3. 卸载 MCP 服务器:

    使用 'uninstall' 命令卸载已安装的 MCP 服务器，同样需要指定 '--client' 参数：

    npx @smithery/cli uninstall mcp-obsidian --client claude

  4. 列出支持的客户端:

    使用 'list clients' 命令查看 Smithery CLI 支持的 AI 客户端列表：

    npx @smithery/cli list clients

  5. 检查已安装的服务器:

    使用 'inspect' 命令交互式检查已安装的服务器，例如检查 'mcp-obsidian' 服务器：

    npx @smithery/cli inspect mcp-obsidian

  6. 运行 MCP 服务器:

    使用 'run' 命令运行已安装的 MCP 服务器，例如运行 'mcp-obsidian' 服务器：

    npx @smithery/cli run mcp-obsidian

    您可以使用 '--config' 参数在运行时提供配置，或使用 '--key' 参数提供 API 密钥。

  7. 查看帮助菜单:

    运行不带任何参数的 'npx @smithery/cli' 或使用 '--help' 参数查看完整的帮助菜单：

    npx @smithery/cli --help

重要提示: 在安装或卸载服务器后，请务必重启您的 AI 客户端 以使更改生效。

信息

分类

开发者工具

访问项目