使用说明

项目简介

'local-command-server' 是一个基于 Model Context Protocol (MCP) 的本地命令执行服务器。它通过 MCP 协议与 LLM 客户端通信,提供 'execute_command' 工具,允许 LLM 客户端调用服务器执行本地系统命令,并将命令执行的结构化输出返回给 LLM 客户端。

主要功能点

  • 执行本地命令: 提供 'execute_command' 工具,LLM 客户端可以指定要执行的系统命令。
  • 结构化输出: 将命令执行的结果以结构化的文本形式返回给 LLM 客户端,方便 LLM 理解和处理命令输出。
  • 易于集成: 基于 MCP 协议,可以方便地与支持 MCP 协议的 LLM 客户端集成,例如 Claude Desktop。

安装步骤

  1. 前提条件: 确保已安装 Node.js 和 npm (Node.js 包管理器)。
  2. 下载代码: 将仓库代码克隆到本地:
    git clone https://github.com/MCP-Mirror/kentaro_mcp-local-command-server.git
  3. 进入目录: 进入项目目录:
    cd kentaro_mcp-local-command-server
  4. 安装依赖: 安装项目所需的依赖包:
    npm install
  5. 构建服务器: 编译 TypeScript 代码,生成可执行的 JavaScript 文件:
    npm run build
    构建成功后,会在项目根目录下生成 'build' 目录,服务器程序 'index.js' 位于该目录下。

服务器配置

要使 MCP 客户端(例如 Claude Desktop)能够连接到 'local-command-server',需要配置客户端的 MCP 服务器设置。在客户端的配置文件中(例如 Claude Desktop 的 'claude_desktop_config.json'),添加以下服务器配置信息:

{
  "mcpServers": {
    "local-command-server": {
      "command": "/path/to/kentaro_mcp-local-command-server/build/index.js" // 请将 "/path/to/kentaro_mcp-local-command-server" 替换为实际的项目本地路径
    }
  }
}

配置说明:

  • '"local-command-server"': 服务器名称,可以自定义,用于在客户端中标识该服务器。
  • '"command"': 必须修改。指向 'local-command-server' 服务器程序 'index.js' 的绝对路径。请根据你的实际项目存放路径进行修改。例如,如果你的项目放在用户根目录下的 'mcp-servers' 文件夹中,并且操作系统是 macOS,则路径可能类似于 '/Users/你的用户名/mcp-servers/kentaro_mcp-local-command-server/build/index.js'。

基本使用方法

  1. 启动服务器: 无需手动启动服务器,MCP 客户端会在需要时自动启动配置的服务器。

  2. 客户端调用: 在支持 MCP 协议的 LLM 客户端中,可以使用 '@tool_name(arguments)' 的形式调用 'local-command-server' 提供的工具。对于 'local-command-server',可以使用的工具是 'execute_command'。

    例如,在 Claude 中,可以使用以下指令来执行 'ls -l' 命令(列出当前目录的文件和详细信息):

    @execute_command(command='ls -l')

    LLM 客户端会将该指令发送到 'local-command-server',服务器执行命令后,会将命令输出返回给 LLM 客户端。

注意: 由于 'execute_command' 工具可以执行任意系统命令,请谨慎使用,并确保只在信任的环境中使用此服务器,避免潜在的安全风险。

信息

分类

桌面与硬件