Edit File Lines MCP Server

Edit File Lines MCP Server

site icon
2024.12.19 19
TypeScript文本编辑代码维护开发效率
mcp-edit-file-lines 是一个基于 TypeScript 的 MCP 服务器,专注于提供对文本文件进行精确行级编辑的工具。它允许用户在允许的目录内对文件进行基于行的编辑,支持字符串或正则表达式模式匹配,替换整行或特定文本匹配,同时保留行格式。此外,它还支持多行和多编辑操作,并提供预览更改的干运行模式。
View on GitHub

Overview

基本能力

产品定位

mcp-edit-file-lines 是一个专门用于文本文件行级编辑的工具,旨在提高开发效率和代码维护的便捷性。

核心功能

  • edit_file_lines: 提供基于行的文件编辑功能,支持字符串或正则表达式模式匹配,可以替换整行或特定文本,保留行格式,支持多行和多编辑操作,并提供干运行模式预览更改。
  • approve_edit: 应用之前干运行的更改,提供两步编辑过程以确保安全。
  • get_file_lines: 检查文件中的特定行,可选上下文行,用于在编辑前验证行内容。
  • search_file: 在文件中搜索文本模式或正则表达式,找到特定的行号及其周围上下文。

适用场景

  • 代码库中的批量替换和更新
  • 配置文件的标准化和更新
  • 代码重构中的变量或函数名替换
  • 多文件内容的一致化修改

工具列表

  1. edit_file_lines: 主编辑工具,支持多种编辑模式。
  2. approve_edit: 安全应用编辑更改。
  3. get_file_lines: 文件内容检查工具。
  4. search_file: 文件内容搜索工具。

常见问题解答

  • 错误处理: 提供清晰的错误消息,如未找到匹配、无效的正则表达式等。
  • 安全考虑: 所有文件操作限制在允许的目录内,防止目录遍历攻击。
  • 编辑状态: 编辑状态在60秒后过期,需重新创建。

使用教程

使用依赖

确保已安装 Node.js 和 npm。

安装教程

  1. 克隆仓库或下载源代码。
  2. 安装依赖:
npm install
  1. 构建服务器:
npm run build

调试方式

  1. 开发模式自动重建:
npm run watch
  1. 运行测试套件:
npm run test
  1. 测试工具脚本:
npm run test:tools
  1. 重置测试夹具:
npm run reset:fixtures

安装类型

未明确指定,留空。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。