使用说明

项目简介

Claude 桌面指挥官 (Claude Desktop Commander) 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在增强 Claude 桌面应用与本地计算机的交互能力。通过此服务器,Claude 可以执行终端命令、管理运行中的进程,并对本地文件系统进行读写和编辑操作。这使得用户能够通过 Claude 与计算机进行更深度的集成,实现自动化任务和更高效的工作流程。

主要功能点

  • 终端命令执行: 允许 Claude 执行终端命令,并实时获取命令输出,支持长时间运行的命令和超时控制。
  • 进程管理: Claude 可以列出和终止计算机上运行的进程,方便用户进行系统管理。
  • 文件系统操作: 支持 Claude 读取、写入、创建、移动、搜索和获取文件信息,实现本地文件管理。
  • 代码编辑: 提供基于文本搜索和替换的代码编辑能力,允许 Claude 对代码文件进行小范围的 Surgical 修改或完全重写。
  • 命令黑名单: 可以配置命令黑名单,限制 Claude 可以执行的终端命令,增强安全性。
  • 会话管理: 支持管理长时间运行的终端命令会话,可以查看会话状态和获取最新的输出。

安装步骤

  1. 安装 Claude 桌面应用: 确保已安装 Claude 桌面应用
  2. 安装 Node.js 和 npm: 确保已安装 Node.jsnpm (通常 Node.js 安装包会自带 npm)。
  3. 通过 npm 安装 Claude Desktop Commander: 打开终端,运行以下命令:
    npx @wonderwhy-er/desktop-commander setup
    或者,如果您希望本地 checkout 代码进行安装和开发,请参考仓库 README 中的 "Option 4: Checkout locally" 部分。
  4. 重启 Claude 桌面应用: 如果 Claude 桌面应用正在运行,请重启使其加载新的 MCP 服务器配置。

服务器配置

Claude 桌面应用需要配置 MCP 服务器的启动信息才能连接到 Claude Desktop Commander。配置信息通常位于 'claude_desktop_config.json' 文件中(macOS 系统通常在 '~/Library/Application\ Support/Claude/claude_desktop_config.json')。

自动配置 (通过 'npx @wonderwhy-er/desktop-commander setup' 命令安装):

如果您使用 'npx @wonderwhy-er/desktop-commander setup' 命令安装,安装脚本会自动将以下配置添加到 'claude_desktop_config.json' 文件中。您无需手动配置,除非您需要自定义服务器名称 "desktop-commander"。

{
  "mcpServers": {
    "desktop-commander": {  // 服务器名称,Claude 客户端用此名称识别和连接
      "command": "npx",    // 启动服务器的命令,这里使用 npx 运行 npm 包
      "args": [             // 启动参数
        "@wonderwhy-er/desktop-commander" // 要运行的 npm 包名称
      ]
    }
  }
}

手动配置 (如果您选择手动安装或本地 checkout):

如果您选择手动安装或本地 checkout 代码,您可能需要手动将配置添加到 'claude_desktop_config.json' 文件中。如果您是本地 checkout 运行,配置可能如下:

{
  "mcpServers": {
    "desktop-commander": {  // 服务器名称,Claude 客户端用此名称识别和连接
      "command": "node",   // 启动服务器的命令,这里使用 node 运行 JavaScript 文件
      "args": [            // 启动参数
        "path/to/your/ClaudeDesktopCommander/dist/index.js" //  指向本地 checkout 代码中编译后的 index.js 文件路径 (请替换为您的实际路径)
      ]
    }
  }
}

注意: 请根据您的实际安装方式选择合适的配置。如果您不确定,推荐使用 'npx @wonderwhy-er/desktop-commander setup' 命令进行安装,它会自动完成配置。

基本使用方法

安装并配置成功后,在 Claude 桌面应用中,您应该可以在 MCP 服务器列表中看到 "desktop-commander" 服务器。Claude 将能够使用以下工具类别与您的计算机进行交互:

  • Terminal Tools (终端工具): 用于执行终端命令和管理会话,例如 'execute_command' (执行命令), 'read_output' (读取输出), 'list_processes' (列出进程) 等。
  • Filesystem Tools (文件系统工具): 用于文件和目录操作,例如 'read_file' (读取文件), 'write_file' (写入文件), 'search_files' (搜索文件) 等。
  • Edit Tools (编辑工具): 用于代码编辑,例如 'edit_block' (编辑代码块) 等。

您可以通过自然语言指示 Claude 使用这些工具来完成各种任务,例如:

  • "在终端中运行 'ls -l' 命令"
  • "读取 '~/Documents/my_document.txt' 文件的内容"
  • "搜索当前目录下包含 'error' 关键词的文件"
  • "将 'my_script.py' 文件移动到 '~/Desktop' 目录"
  • "将 'src/index.js' 文件中的 'console.log("hello")' 替换为 'console.log("world")'"

请参考仓库 README 和项目文档了解更详细的工具使用方法和示例。

信息

分类

桌面与硬件