使用说明

项目简介

local-command-server 是一个使用 TypeScript 开发的 MCP 服务器,它提供了一个 'execute_command' 工具,允许 LLM 客户端指示服务器在本地操作系统上执行指定的命令,并将命令的结构化输出返回给 LLM。这使得 LLM 能够与本地系统进行交互,执行脚本或获取系统信息。

主要功能点

  • 命令执行工具 (execute_command): 提供一个名为 'execute_command' 的工具,LLM 可以调用此工具来执行任何有效的操作系统命令。
  • 结构化输出: 服务器会将命令执行的结果以结构化的文本形式返回给 LLM,方便 LLM 理解和处理命令输出。
  • MCP 协议兼容: 基于 Model Context Protocol 标准构建,可以与任何兼容 MCP 协议的 LLM 客户端进行通信。
  • Stdio 传输: 使用标准输入输出 (Stdio) 作为默认的通信协议,易于部署和集成。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。
  2. 克隆仓库: 将 'mcp-local-command-server' 仓库克隆到本地:
    git clone https://github.com/kentaro/mcp-local-command-server.git
    cd mcp-local-command-server
  3. 安装依赖: 在仓库目录下运行以下命令安装项目依赖:
    npm install
  4. 构建服务器: 运行以下命令编译 TypeScript 代码并生成可执行的 JavaScript 文件:
    npm run build
    构建成功后,会在 'build' 目录下生成 'index.js' 文件,这就是服务器的入口文件。

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,您需要配置客户端以连接到此服务器。配置通常在客户端的配置文件中完成。以 Claude Desktop 为例,您需要编辑 'claude_desktop_config.json' 文件,并添加 'mcpServers' 配置项。

配置文件路径:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容 (json):

{
  "mcpServers": {
    "local-command-server": {  // 服务器名称,客户端用此名称引用
      "command": "/path/to/mcp-local-command-server/build/index.js" // 服务器启动命令,需要替换为实际的 index.js 文件路径
    }
  }
}

配置参数说明:

  • '"local-command-server"': 服务器的名称,可以自定义,客户端通过这个名称来识别和调用该服务器。
  • '"command"': 重要 - 服务器的启动命令。您需要将 '"/path/to/mcp-local-command-server/build/index.js"' 替换为 您本地 'mcp-local-command-server' 仓库 'build/index.js' 文件的绝对路径。 例如,如果您的仓库在用户目录下的 'projects/mcp-local-command-server' 文件夹中,那么在 MacOS 上,路径可能类似于 '"/Users/your_username/projects/mcp-local-command-server/build/index.js"'。请根据您的实际情况修改。

注意: 'args' 字段在此配置中省略,因为此服务器不需要额外的启动参数。如果服务器需要参数,可以在 'command' 字段后添加 'args' 数组进行配置。

基本使用方法

  1. 启动 MCP 服务器: 当 MCP 客户端(如 Claude Desktop)启动并加载配置后,'local-command-server' 会作为 MCP 服务器在后台运行。它通过 Stdio 与客户端通信。您无需手动启动服务器,客户端会自动处理。
  2. 在 LLM 中调用工具: 在与 LLM 的对话中,您可以指示 LLM 使用 'execute_command' 工具来执行命令。例如,您可以提示 LLM "请使用 'execute_command' 工具执行命令 'ls -l' 查看当前目录的文件列表"。
  3. 服务器执行命令并返回结果: MCP 服务器接收到客户端的工具调用请求后,会执行您指定的命令(例如 'ls -l'),并将命令的输出结果结构化后返回给 LLM 客户端。
  4. LLM 处理结果: LLM 客户端接收到服务器返回的命令执行结果,并可以将其用于后续的对话生成或其他任务。

安全提示: 'execute_command' 工具具有执行本地系统命令的能力,请谨慎使用,并确保只在可信的环境中使用此 MCP 服务器,以避免潜在的安全风险。请勿在不可信的 LLM 或环境中配置和使用此服务器。

信息

分类

桌面与硬件