MCP Tool Documentation

MCP Tool Documentation

site icon
2025.04.24 0
ShellMCP 服务器管理命令行工具开发工具集成开发效率
MCP Tool 是一个命令行工具,用于管理 Model Context Protocol (MCP) 服务器。它提供了一个统一的接口来运行、配置和集成各种 MCP 服务器,并与 Claude 和 Cursor 等工具进行交互。该工具支持列出服务器和服务器组、运行服务器、生成文档、输出 JSON 定义等核心功能,同时还提供了 Claude 和 Cursor 集成、交互式菜单、配置向导等高级功能。
View on GitHub

Overview

基本能力

产品定位

MCP Tool 是一个用于管理 MCP 服务器的命令行工具,旨在简化 MCP 服务器的运行、配置和集成流程。

核心功能

  • 列出服务器和服务器组:查看可用的 MCP 服务器和服务器组。
  • 运行服务器:支持单独运行服务器或服务器组,并可选择后台运行模式。
  • 显示服务器信息:提供服务器或服务器组的详细信息。
  • 生成文档:为所有服务器生成全面的文档。
  • 输出 JSON 定义:将服务器或服务器组的定义以 JSON 格式输出。
  • Claude 和 Cursor 集成:将服务器定义添加到 Claude 或 Cursor 的 MCP 配置中。
  • 交互式模式:通过用户友好的菜单界面管理服务器。
  • 配置向导:设置服务器所需的环境变量。
  • Shell 集成:提供自动完成功能,方便在 shell 中使用。

适用场景

  • 开发环境管理:快速启动和管理开发环境中的 MCP 服务器。
  • 工具集成:将 MCP 服务器集成到 Claude 或 Cursor 等工具中。
  • 自动化脚本:通过命令行工具实现服务器管理的自动化。
  • 团队协作:统一团队中的服务器配置和运行方式。

工具列表

  • mcptool.sh:主脚本,提供所有功能的统一入口。
  • jq:JSON 处理器,用于解析服务器配置。
  • dialog:用于交互式模式的菜单界面。

常见问题解答

  1. JSON 文件未找到:确保指定正确的路径或检查环境变量 MCP_CONFIG_FILE
  2. 缺少依赖:安装 jqdialog
  3. 缺少环境变量:检查服务器文档并设置所需变量。
  4. 'add' 命令失败:确保提供有效的目标并检查目标文件是否可写。
  5. JSON 格式错误:使用 jq 验证 JSON 文件。

使用教程

使用依赖

  1. 安装 jqbash brew install jq # macOS sudo apt-get install -y jq # Ubuntu/Debian
  2. 安装 dialog(可选,用于交互式模式): bash brew install dialog # macOS sudo apt-get install -y dialog # Ubuntu/Debian

安装教程

  1. 克隆或下载脚本文件: bash git clone https://github.com/your-username/mcptool.git cd mcptool
  2. 使主脚本可执行: bash chmod +x mcptool.sh
  3. (可选)创建别名: bash alias mcpt='/path/to/mcptool.sh'

调试方式

  1. 运行服务器: bash ./mcptool.sh run server_name
  2. 查看服务器信息: bash ./mcptool.sh info server_name
  3. 生成文档: bash ./mcptool.sh docs
  4. 启动交互式模式: bash ./mcptool.sh interactive

许可证

该项目遵循 Other 开源许可条款,请参阅 Other 了解完整条款。