使用说明
项目简介
MCPSX 命令行工具 (MCPSX CLI) 旨在简化 Model Context Protocol (MCP) 服务器和工具的管理。它允许用户轻松地启动、配置和分组 MCP 服务器,并通过命令行界面与 MCP 环境进行交互。MCPSX 主要用于辅助 MCP 客户端(如 VSCode 扩展)与后端的 MCP 服务器建立连接和管理会话。
主要功能点
- 运行服务器与工具: 快速启动单个或多个 MCP 服务器和工具,支持灵活组合。
- 配置管理: 便捷地添加、删除和管理 MCP 服务器的配置信息。
- 服务器分组: 创建和管理服务器组,简化复杂 MCP 环境的启动和管理。
- 灵活过滤: 根据名称或分组筛选需要运行的服务器和工具。
- STDIO 服务器模式: 支持以 STDIO 模式运行 MCP 服务器,方便与客户端(如 VSCode 扩展)集成。
安装步骤
- 确保已安装 Node.js 和 npm。
- 打开终端,运行以下命令全局安装 MCPSX CLI:
或者,您可以使用 'npx' 临时运行 MCPSX CLI,而无需全局安装:npm install -g @jasonkneen/mcpsxnpx @jasonkneen/mcpsx
服务器配置
MCP 客户端(例如 VSCode 扩展)需要配置 MCP 服务器的启动命令及其参数,才能连接到 MCPSX 管理的 MCP 服务器。以下是一个 JSON 格式的配置示例,展示了如何配置一个名为 "My Server" 的 MCP 服务器。
{ "servers": [ { "name": "My Server", // 服务器名称,用户自定义,用于在客户端中标识和选择服务器 "command": "mcpsx", // 启动 MCP 服务器的命令,这里使用 mcpsx 自身 "args": ["run"] // 启动命令的参数,这里使用 "run" 子命令启动 MCPSX,实际场景可能需要根据具体MCP服务器调整 // 其他可选配置,例如 "env" (环境变量) 等,可以参考 mcpsx 的文档进行添加 } ] }
配置说明:
- 'servers': 配置服务器列表。
- 'name': 服务器的唯一名称,在客户端中用于标识和选择。
- 'command': 启动 MCP 服务器的可执行命令。 在这个例子中,我们使用 'mcpsx run' 命令来启动 MCPSX 本身作为一个简单的 MCP 服务器管理器。 实际应用中,如果您的 MCP 服务器是另一个独立的程序(例如用 Python 编写的服务器),则需要将 'command' 指向该程序的启动脚本,并将 'args' 设置为相应的启动参数。
- 'args': 传递给 'command' 的命令行参数,以数组形式表示。 'mcpsx run' 命令会根据您的配置启动 MCP 服务器。您可以根据需要添加其他参数,例如指定要加载的服务器或工具 ('--server', '--servers', '--tool', '--tools')。
注意: 上述配置是一个基础示例,实际 MCP 服务器的配置可能更复杂,需要根据您使用的具体 MCP 服务器和工具进行调整。 MCPSX CLI 本身作为一个 MCP 服务器 管理器,它的 'run' 命令可以启动和管理其他 MCP 服务器。 如果您需要配置和运行特定的 MCP 服务器(例如,一个提供特定模型或工具的服务器),您需要:
- 安装并配置您需要的 MCP 服务器: 这可能涉及到安装特定的软件包、配置环境变量等,具体步骤请参考您使用的 MCP 服务器的文档。
- 在 MCPSX 中添加服务器配置: 使用 'mcpsx add' 命令或直接编辑 '~/.mcpsx/config.json' 文件,将您的 MCP 服务器的启动命令和参数配置到 MCPSX 中。
- 在 MCP 客户端中配置连接信息: 将 MCP 客户端配置为连接到 MCPSX 管理的 MCP 服务器。通常,您需要指定服务器的名称 (在 MCPSX 配置中定义的 'name')。 客户端会通过 MCPSX 与实际的 MCP 服务器进行通信。
基本使用方法
-
启动 MCP 服务器 (STDIO 模式): 打开终端,运行 'mcpsx run' 命令,即可启动 MCPSX 作为 STDIO 服务器。 这通常用于配合 MCP 客户端(如 VSCode 扩展)使用。
mcpsx run -
列出已配置的 MCP 服务器: 使用 'mcpsx list' 命令查看已添加的 MCP 服务器配置列表。
mcpsx list -
添加新的 MCP 服务器配置: 使用 'mcpsx add <服务器名称>' 命令添加新的 MCP 服务器配置。 例如,添加一个名为 "MyServer" 的配置,启动命令为 'node server.js':
mcpsx add "MyServer" --command "node" --args "server.js" -
使用服务器组: 首先创建服务器组,例如创建一个名为 "my-group" 的服务器组,包含 "server1" 和 "server2":
mcpsx groups add "my-group" --servers="server1,server2"然后,使用 'mcpsx run' 命令启动该服务器组:
mcpsx run --servers="my-group" -
查看帮助信息: 使用 'mcpsx help' 命令查看 MCPSX CLI 的帮助信息,了解更多命令和选项。
mcpsx help
更多详细用法和高级配置,请参考 MCPSX CLI 的官方文档或使用 'mcpsx help' 命令查看帮助信息。
信息
分类
开发者工具