使用说明

项目简介

wcgw (Shell and Coding agent for Claude and Chatgpt) 是一个MCP(Model Context Protocol)服务器,旨在增强聊天应用程序(如Claude和ChatGPT)的能力,使其能够与您的本地计算机进行更深入的交互。通过 wcgw,AI助手可以执行Shell命令、读写文件、编辑代码,从而实现更复杂的编程和自动化任务。它为LLM客户端提供了一个安全、可扩展的上下文服务框架,使其能够利用本地资源和工具。

主要功能点

  • Shell命令执行: 允许AI助手在您的本地计算机上执行Shell命令,从而实现代码构建、测试、运行等操作。
  • 文件系统访问: 提供读写本地文件的能力,使AI助手可以读取项目代码、创建新文件或修改现有文件。
  • 代码编辑: 支持对代码文件进行搜索和替换编辑,并具备一定的语法检查能力,辅助AI进行代码修改和维护。
  • 上下文保存与恢复: 允许保存当前任务的上下文信息(包括文件内容),以便后续在新的会话中恢复任务,或将上下文转移给其他AI助手。
  • 安全控制: 提供多种运行模式(architect, code-writer, wcgw),可以限制AI助手的操作权限,例如限制文件编辑路径、允许执行的命令等,以确保本地计算机的安全。
  • 终端会话连接: 支持连接到AI助手正在使用的终端会话,方便用户查看命令历史、中断进程或进行交互。

安装步骤

  1. 安装 'uv': 'wcgw' 依赖 'uv' 包管理器。如果您的系统上没有安装 'uv',请使用 Homebrew 安装:
    brew install uv
    注意: 确保 'uv' 可执行文件位于全局路径(如 '/usr/bin/')。
  2. 为 Claude Desktop 安装 wcgw: 使用 Smithery 命令行工具自动安装和配置 'wcgw' for Claude Desktop:
    npx -y @smithery/cli install wcgw --client claude
    前提条件: 您需要先安装 Node.js 和 npm (Smithery CLI 的运行环境)。
  3. 重启 Claude Desktop 应用: 安装完成后,请重启 Claude Desktop 应用程序以加载新的 MCP 服务器配置。

服务器配置 (Claude Desktop)

要使 Claude Desktop 客户端连接到 'wcgw' MCP 服务器,您需要编辑 Claude Desktop 的配置文件 'claude_desktop_config.json' (通常位于 '~/Library/Application Support/Claude/claude_desktop_config.json' on macOS)。在 'mcpServers' 字段下添加 'wcgw' 服务器的配置:

{
  "mcpServers": {
    "wcgw": {
      "command": "uv",
      "args": [
        "tool",
        "run",
        "--from",
        "wcgw@latest",
        "--python",
        "3.12",
        "wcgw_mcp"
      ]
    }
  }
}
  • '"server name": "wcgw"': MCP 服务器的名称,您可以自定义。
  • '"command": "uv"': 运行 MCP 服务器的命令,这里使用 'uv tool run'。请确保 'uv' 命令在您的系统环境变量 PATH 中。如果不在,请提供 'uv' 可执行文件的完整路径。
  • '"args"': 传递给 'uv tool run' 命令的参数列表:
    • '"tool"': 指定 'uv' 运行工具。
    • '"run"': 'uv' 的子命令,用于运行指定的工具。
    • '"--from"': 指定工具的来源,这里是 'wcgw@latest',表示从 'wcgw' 包的最新版本安装和运行。
    • '"--python"': 指定运行 'wcgw' MCP 服务器所需的 Python 版本,这里是 '3.12'。
    • '"wcgw_mcp"': 'wcgw' 包中 MCP 服务器的入口点。

基本使用方法

  1. 启动 Claude Desktop: 确保已配置并启动 Claude Desktop 应用程序。
  2. 验证连接: 如果配置正确,您应该在 Claude Desktop 界面中看到 MCP 连接图标 (🚀),表示 Claude Desktop 已成功连接到 'wcgw' MCP 服务器。
  3. 与 Claude 交互: 现在您可以指示 Claude 执行各种本地任务,例如:
    • "请执行 'ls -l' 命令查看当前目录的文件列表。"
    • "读取文件 'my_project/README.md' 的内容。"
    • "创建一个名为 'output.txt' 的新文件,内容为 'Hello from Claude!'。"
    • "编辑文件 'settings.json',将 API 密钥更新为 '新的密钥值'。"

注意: 请务必谨慎使用 'BashCommand' 工具,特别是当允许 AI 助手执行任意命令时,务必仔细审查命令内容,避免潜在的数据丢失或安全风险。

信息

分类

桌面与硬件