使用说明

项目简介

mcpz CLI 是一个用于管理和运行 MCP 服务器的命令行工具。它允许用户轻松配置、启动和管理 MCP 服务器及其工具,支持通过 stdio 与客户端通信。该工具本身似乎就包含了 MCP 服务器的执行能力,可以通过简单的命令启动 MCP 服务。

主要功能点

  • 启动和管理 MCP 服务器与工具
  • 添加、移除和列出 MCP 服务器配置
  • 创建和管理服务器与工具分组
  • 灵活的服务器和工具过滤启动选项

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 全局安装 mcpz CLI:
    npm install -g @mcpz/cli

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能连接。以下是一个 MCP 客户端可能的服务器配置示例,用于连接由 'mcpz cli' 启动的 MCP 服务器:

{
  "serverName": "MyMCPServer",
  "command": "mcpz",
  "args": "run"
}
  • 'serverName': 服务器配置的名称,可以自定义,例如 "MyMCPServer"。
  • 'command': 启动 MCP 服务器的命令,这里设置为 'mcpz',因为 'mcpz cli' 提供了运行服务器的功能。
  • 'args': 传递给 'mcpz' 命令的参数。示例中使用 'run' 参数启动默认配置的 MCP 服务器。您可以根据需要修改 'args' 来指定要运行的服务器或工具,例如 '"run --servers=python,sleep"'。

更细化的配置示例:

如果您需要运行特定的服务器组合,可以使用 'servers' 参数:

{
  "serverName": "PythonStackServer",
  "command": "mcpz",
  "args": "run --servers=python,pytorch,huggingface"
}

或者运行特定的工具:

{
  "serverName": "ToolServer",
  "command": "mcpz",
  "args": "run --tools=predict"
}

基本使用方法

  1. 安装 mcpz CLI: 按照安装步骤进行安装。
  2. 配置 MCP 客户端: 在 MCP 客户端中,配置连接到 MCP 服务器的设置。根据上面的“服务器配置”部分,配置 'command' 和 'args' 以启动 'mcpz' 并运行所需的服务器或工具。
  3. 启动 MCP 客户端: 启动 MCP 客户端,客户端将使用配置的命令和参数来连接并与 MCP 服务器通信。
  4. 使用 mcpz CLI 管理服务器 (可选): 您可以使用 'mcpz' 命令行工具来管理服务器配置、分组等,例如使用 'mcpz add' 添加新的服务器配置,使用 'mcpz list' 列出配置,使用 'mcpz groups' 管理服务器分组等。 这些管理操作通常在服务器端进行,用于预先配置好服务器运行环境。

注意: MCP 客户端需要根据实际使用的服务器配置和需求,正确配置 'command' 和 'args',以便 'mcpz cli' 能够启动并运行期望的 MCP 服务。

信息

分类

开发者工具