MCP Terminal Server 使用说明

项目简介

MCP Terminal Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 提供安全且可控的本地终端访问能力。通过此服务器，LLM 可以在您的授权范围内执行终端命令、进行文件系统操作以及管理环境变量，从而扩展 LLM 的能力边界，使其能够与本地系统进行更深入的交互。

主要功能点

安全命令执行：允许 LLM 安全地执行终端命令，所有操作均在预先配置的允许路径和权限范围内进行，保障系统安全。
文件系统操作：支持在限定的目录范围内进行文件和目录操作，使 LLM 能够访问和处理本地文件数据。
环境变量管理：允许 LLM 管理和使用系统环境变量，以便更好地与环境交互。
跨平台支持：支持 Windows、macOS 和 Linux 等主流操作系统。
远程命令执行：支持通过命令执行远程系统连接 (如 SSH)，扩展 LLM 的操作范围。

安装步骤

克隆仓库

git clone https://github.com/dillip285/mcp-terminal.git
cd mcp-terminal

安装依赖 确保您已安装 Node.js 和 npm，然后运行：
```
npm install
```

服务器配置

MCP Terminal Server 需要在 MCP 客户端中配置才能使用。以 Claude Desktop 为例，您需要在 Claude Desktop 的配置文件中添加以下服务器配置信息。

{
  "mcpServers": {
    "terminal": {  // 服务器名称，可以自定义
      "command": "npx",  // 启动服务器的命令，这里使用 npx 运行 npm 包
      "args": [
        "@dillip285/mcp-terminal", // MCP Terminal Server 的 npm 包名
        "--allowed-paths",  // 参数：指定允许访问的文件路径
        "/path/to/allowed/directory" // 参数值：您希望允许 LLM 访问的目录路径，请替换为实际路径
      ]
    }
  }
}

配置说明:

'"terminal"': 服务器的名称，您可以自定义，用于在 MCP 客户端中标识和引用该服务器。
'"command": "npx"': 指定用于启动服务器的命令。'npx' 用于执行 npm 包，确保可以找到并运行 '@dillip285/mcp-terminal' 包。
'"args"': 一个字符串数组，包含传递给启动命令的参数。
- '"@dillip285/mcp-terminal"': 指定要执行的 npm 包，即 MCP Terminal Server 的入口。
- '"--allowed-paths"': MCP Terminal Server 提供的参数，用于设置允许 LLM 访问的文件系统路径，请务必根据您的需求修改 '/path/to/allowed/directory' 为实际的、安全的目录路径。您可以配置多个路径，以逗号分隔。

请注意: 您需要将 '/path/to/allowed/directory' 替换为您希望允许 LLM 访问的实际目录路径。为了安全起见，请仔细考虑并限制允许访问的路径范围。

配置完成后，重启您的 MCP 客户端（例如 Claude Desktop）使配置生效。

基本使用方法

配置并启动 MCP Terminal Server 后，您可以在支持 MCP 协议的 LLM 客户端中使用 'execute_command' 工具来执行终端命令。

例如，在 Claude 中，您可以指示 Claude 使用 'execute_command' 工具执行命令，例如：

'请使用 execute_command 工具执行命令 "ls -l /path/to/allowed/directory"'

LLM 将会调用 MCP Terminal Server 提供的 'execute_command' 工具，在您配置的允许路径下执行 'ls -l /path/to/allowed/directory' 命令，并将命令执行结果返回给您。

工具名称: 'execute_command'

工具描述: 执行终端命令。

工具参数:

'command' (string, 必填): 要执行的命令。
'args' (array of string, 可选): 命令的参数，以字符串数组形式提供。
'cwd' (string, 可选): 命令执行的工作目录。

请参考 MCP 客户端的文档，了解如何在您的客户端中使用 MCP 服务器提供的工具。

关键词