使用说明

项目简介

'mcp-editor' 是一个 MCP 服务器,它将 Anthropic 演示项目中的文件系统编辑工具移植到了 TypeScript 环境,并使其能够通过 MCP 协议与 LLM 客户端进行交互。此服务器允许 LLM 控制和编辑服务器运行环境中的文件系统。

请注意安全警告: 该 MCP 服务器没有访问控制,依赖客户端的审批机制。请务必谨慎使用,不要自动批准写入操作,以避免潜在的风险。此项目非活跃维护,仅供参考学习。

主要功能点

  • 查看文件和目录: 允许 LLM 查看指定路径的文件内容或目录结构。可以查看整个文件或指定行范围。
  • 创建文件: 允许 LLM 在指定路径创建新文件,并写入指定内容。
  • 字符串替换: 允许 LLM 在文件中替换指定的字符串。
  • 插入文本: 允许 LLM 在文件的指定行号插入新的文本内容。
  • 撤销编辑: 允许 LLM 撤销最近一次的文件编辑操作。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库到本地:
    git clone https://github.com/arathald/mcp-editor.git
  3. 进入项目目录:
    cd mcp-editor
  4. 安装依赖:
    npm install
  5. 构建项目:
    npm build

服务器配置

对于 MCP 客户端,您需要配置以下 JSON 对象以连接到 'mcp-editor' 服务器。请根据实际安装路径修改 'args' 中的路径。

{
  "mcpServers": {
    "mcp-editor": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-editor/dist/server.js"]  // 将 "/absolute/path/to/mcp-editor" 替换为 mcp-editor 的实际绝对路径
    }
  }
}

基本使用方法

启动服务器后,MCP 客户端(例如 Claude 桌面应用)可以通过配置连接到 'mcp-editor' 服务器。连接成功后,LLM 即可通过自然语言指令调用服务器提供的文件编辑工具,例如:

  • 请求查看文件内容:'view path: "/path/to/file.txt"'
  • 请求创建文件:'create path: "/path/to/new_file.txt", file_text: "文件内容"'
  • 请求替换字符串:'string_replace path: "/path/to/file.txt", old_str: "旧字符串", new_str: "新字符串"'
  • 请求插入文本:'insert path: "/path/to/file.txt", insert_line: 10, new_str: "插入的文本"'
  • 请求撤销编辑:'undo_edit path: "/path/to/file.txt"'

具体的工具调用方式和参数需要参考 MCP 客户端的文档和 'mcp-editor' 服务器提供的工具描述。

信息

分类

数据库与文件