使用说明
项目简介
Shell MCP 是一个使用 Bash 脚本实现的轻量级 Model Context Protocol (MCP) 服务器。它旨在简化命令行工具的管理和调用,通过标准的 JSON-RPC 接口向客户端提供工具服务。虽然功能相对基础,但它提供了一个快速搭建和使用自定义命令行工具服务的框架。
主要功能点
- 工具管理: 允许用户创建、注册和管理命令行工具。工具被组织在 'tools' 目录下,易于扩展和维护。
- JSON-RPC 接口: 通过简化的 JSON-RPC 协议与客户端通信,接收工具调用请求并返回结果。
- 可扩展性: 通过简单的脚本编写规范,用户可以轻松地添加新的命令行工具,扩展服务器的功能。
- 基础 MCP 功能: 实现了 MCP 协议中关于工具管理和调用的核心功能,为构建基于命令行工具的上下文服务提供了基础框架。
安装步骤
- 克隆仓库: 从 GitHub 克隆 'shell-mcp' 仓库到本地。
git clone https://github.com/deemkeen/shell-mcp.git cd shell-mcp - 安装依赖: 确保系统已安装 'bash' (版本 4.0 或更高) 和 'jq' 工具。
# Debian/Ubuntu sudo apt-get update sudo apt-get install bash jq # CentOS/RHEL sudo yum install bash jq # macOS (using Homebrew) brew install bash jq - 添加工具 (可选): 可以根据需要,按照仓库说明添加自定义的工具脚本到 'tools' 目录下。
服务器配置
MCP 客户端需要配置连接到 Shell MCP 服务器的信息。以下是一个典型的配置示例(JSON 格式):
{ "serverName": "shell-mcp", "command": "./mcp-server.sh", "args": [] }
配置参数说明:
- 'serverName': 服务器名称,可以自定义,用于在客户端标识服务器。例如: '"shell-mcp"'。
- 'command': 启动服务器的命令。对于 Shell MCP,始终为 '"./mcp-server.sh"',指向服务器脚本的路径。
- 'args': 启动服务器命令的参数。Shell MCP 服务器脚本本身没有启动参数,所以这里配置为空数组 '[]'。
基本使用方法
-
启动服务器: 在仓库根目录下,运行以下命令启动 Shell MCP 服务器。
./mcp-server.sh服务器将开始监听标准输入 (stdin) 上的 JSON-RPC 请求。
-
调用工具: MCP 客户端需要构造符合 JSON-RPC 协议的请求,发送到服务器的标准输入 (stdin)。请求的具体格式需要参考 MCP 协议文档以及 'shell-mcp' 仓库中 'Protocol' 部分的描述。例如,要列出所有可用工具,客户端需要发送 'tools/list' 方法的 JSON-RPC 请求。调用特定工具则需要使用 'tools/call' 方法,并提供工具名称和参数。
注意: Shell MCP 仓库的 README.md 主要侧重于工具的创建和管理,并没有详细说明 JSON-RPC 请求的具体格式。开发者可能需要查看 MCP 协议的通用规范,并结合 'shell-mcp' 的代码来理解如何构造和发送 JSON-RPC 请求以调用工具。
信息
分类
开发者工具