关键词

文件编辑代码修改文本操作开发工具自动化

使用说明

项目简介

这是一个基于Model Context Protocol (MCP) 的服务器，旨在为LLM客户端提供文件编辑能力。通过此服务器，用户可以使用LLM客户端安全地编辑指定目录下的文本文件，实现代码或文本的自动化修改。

主要功能点

  • 'edit_file_lines': 允许用户通过字符串或正则表达式匹配，对文件进行基于行的编辑，包括替换行内容、替换匹配文本等，支持预览更改（dry run）和两步确认，确保编辑安全可控。
  • 'approve_edit': 确认并应用 'edit_file_lines' 工具的预览更改，需要提供 dry run 阶段返回的状态ID。
  • 'get_file_lines': 获取文件中指定行的内容，并提供上下文行，用于在编辑前验证目标行内容。
  • 'search_file': 在文件中搜索文本或正则表达式，返回匹配的行号、内容以及上下文信息，帮助用户快速定位需要编辑的代码或文本位置。

安装步骤

  1. 确保已安装Node.js和npm。
  2. 克隆或下载此仓库到本地。
  3. 在仓库根目录下，打开终端并运行 'npm install' 安装项目依赖。
  4. 运行 'npm run build' 构建服务器，生成可执行的 JavaScript 代码。

服务器配置

要将此MCP服务器与MCP客户端（例如 Claude）配合使用，您需要在客户端的配置文件中添加服务器配置信息。以下是一个示例配置，您需要根据实际情况修改路径：

{
  "mcpServers": {
    "edit-file-lines": {
      "command": "node",
      "args": [
        "/path/to/edit-file-lines/build/index.js",  // 请替换为 edit-file-lines 项目 build 目录下的 index.js 文件的绝对路径
        "/path/to/allowed-directory"                 // 请替换为允许访问的目录的绝对路径，例如您的代码仓库根目录。可以指定多个目录，空格分隔。
      ]
    }
  }
}

配置参数说明:

  • 'server name': 'edit-file-lines' (此名称可自定义，用于在客户端中标识该服务器)
  • 'command': 'node' (Node.js 运行环境命令)
  • 'args': 启动服务器的参数，包括：
    • '/path/to/edit-file-lines/build/index.js': 必须修改 为实际 'index.js' 文件在您本地文件系统中的绝对路径。
    • '/path/to/allowed-directory': 必须修改 为您希望允许此服务器访问的根目录的绝对路径。为了安全起见，服务器只能访问这些允许目录及其子目录中的文件。您可以添加多个允许目录，每个目录之间用空格分隔。

基本使用方法

  1. 启动服务器: 在终端中，导航到 'edit-file-lines' 项目的根目录，运行命令 'node build/index.js <allowed-directory> [additional-directories...]'，其中 '<allowed-directory>' 是你允许服务器访问的目录。可以指定多个允许目录。
  2. 客户端连接: 在配置好MCP客户端后，客户端应该能够自动连接到此服务器。
  3. 调用工具: 使用MCP客户端，通过JSON-RPC请求调用服务器提供的工具，例如 'edit_file_lines'、'search_file' 等。具体的请求参数和响应格式，请参考仓库的 README 文档和工具的详细描述。您可以利用 'search_file' 工具先查找目标代码行，然后使用 'edit_file_lines' 工具进行编辑，并使用 'approve_edit' 确认更改。

信息

分类

开发者工具

访问项目