关键词

shell命令命令行工具系统管理自动化工具执行

使用说明

项目简介

本项目 'mcp-server-cli' 是一个基于 Model Context Protocol (MCP) 的服务器实现，它提供了一个简单的工具 'run-command'，允许连接到该服务器的 MCP 客户端（例如 LLM 应用）在服务器的操作系统上执行 shell 命令。

主要功能点

  • 工具执行: 提供 'run-command' 工具，LLM 可以调用此工具执行任意 shell 命令。
  • 标准输入输出 (Stdio) 传输: 使用标准输入输出作为 MCP 服务器的通信通道，易于集成和部署。
  • 跨平台兼容: 理论上支持多种操作系统，可以执行操作系统支持的 shell 命令。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已经安装了 Node.js 和 npm (Node.js 包管理器)。
  2. 克隆仓库: 将 GitHub 仓库 'https://github.com/hdcola/mcp-server-cli' 克隆到本地。 
    git clone https://github.com/hdcola/mcp-server-cli
cd mcp-server-cli
  3. 安装依赖: 在仓库目录下运行 npm 命令安装项目依赖。 
    npm install
  4. 全局安装 (可选): 如果希望在任何地方都能直接运行 'mcp-server-cli' 命令，可以进行全局安装。 
    npm install -g .
    或者使用 'npm link' 在本地链接： 
    npm link

服务器配置

MCP 客户端需要配置连接到 'mcp-server-cli' 服务器的信息。以下是一个 JSON 格式的配置示例，用于 MCP 客户端：

{
  "serverName": "mcp-server-cli",
  "command": "mcp-server-cli",
  "args": [],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器名称，可以自定义，例如 'mcp-server-cli'。
  • 'command': MCP 服务器的启动命令。 如果你进行了全局安装，这里填写 'mcp-server-cli' 即可。 如果没有全局安装，需要填写 'node' 和服务器脚本的路径，例如 '"command": "node"'， '"args": ["/path/to/mcp-server-cli/src/index.ts"]'。 请根据你的实际安装情况配置此项。 如果全局安装了，直接使用 '"command": "mcp-server-cli"' 最为方便。
  • 'args': 启动命令的参数，本例中不需要额外参数，所以为空数组 '[]'。
  • 'transport': 传输协议，本服务器使用标准输入输出，所以设置为 '"stdio"'。

基本使用方法

  1. 启动 MCP 服务器: 在终端中运行 'mcp-server-cli' 命令（如果全局安装）或者 'node src/index.ts' （如果本地运行）。服务器成功启动后，会在控制台输出 'CLI MCP Server running on stdio'。

  2. 配置 MCP 客户端: 在你的 MCP 客户端应用中，根据上述 “服务器配置” 部分的 JSON 配置信息，配置连接到 'mcp-server-cli' 服务器。

  3. 调用 'run-command' 工具: 在 MCP 客户端中，你可以调用 'run-command' 工具，并提供 'command' 参数来执行 shell 命令。例如，发送如下 JSON-RPC 请求：

    {
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "tool_name": "run-command",
    "arguments": {
      "command": "ls -l"  // 要执行的 shell 命令，例如列出当前目录文件
    }
  },
  "id": 1
}

  4. 接收工具调用结果: MCP 服务器会将 shell 命令的执行结果（标准输出和标准错误）封装在 JSON-RPC 响应中返回给客户端。客户端解析响应即可获取命令执行结果。

注意: 执行 shell 命令存在安全风险，请谨慎使用此工具，并确保只在可信的环境中运行。

信息

分类

桌面与硬件

访问项目