MCP Server Text Editor

🚀 Claude 文本編輯器 MCP 服務器

Claude 文本編輯器 MCP 服務器是一個開源項目，它實現了 Model Context Protocol (MCP) 服務器，模仿了 Claude 的內置文本編輯器工具。該項目提供了與 Claude 內置文本編輯器工具相同的接口，允許用戶通過標準 API 查看、編輯和創建文本文件。

🚀 快速開始

Claude 文本編輯器 MCP 服務器為開發者提供了便捷的文本文件操作方式。通過標準 API，你可以輕鬆查看、編輯和創建文本文件。以下是快速開始的步驟：

安裝

# 從 npm 安裝
npm install mcp-server-text-editor

初始化配置

在項目中引入並初始化文本編輯器服務器：

import { TextEditorServer } from 'mcp-server-text-editor';

// 創建一個文本編輯器服務器實例
const textEditor = new TextEditorServer({
  port: 3000, // 可選，默認端口為 3000
  logger: console // 可選，默認使用控制檯日誌
});

使用示例

// 查看幫助信息
textEditor.help();

// 顯示版本信息
textEditor.version();

// 打開文件進行編輯
textEditor.open('path/to/file.txt', (content) => {
  // 在此處編輯內容
});

// 創建新文件
textEditor.create('newFile.txt', () => {
  console.log('文件已創建');
});

✨ 主要特性

• 與 Claude 文本編輯器相同的 API：實現了與 Claude 的內置文本編輯器工具完全相同的接口，方便開發者無縫對接。
• MCP 服務器實現：遵循 AI 工具集成的標準 Model Context Protocol 協議，確保系統的規範性和兼容性。
• 文件操作豐富：
  • 查看文件內容，可選指定行範圍，滿足不同的查看需求。
  • 創建新文件，快速生成所需文本文件。
  • 替換現有文件中的文本，高效修改文件內容。
  • 在特定行插入文本，靈活編輯文件。
  • 撤銷上一次編輯，避免誤操作帶來的損失。

📦 安裝指南

# 從 npm 安裝
npm install mcp-server-text-editor

💻 使用示例

基礎用法

import { TextEditorServer } from 'mcp-server-text-editor';

// 創建一個文本編輯器服務器實例
const textEditor = new TextEditorServer({
  port: 3000, // 可選，默認端口為 3000
  logger: console // 可選，默認使用控制檯日誌
});

// 查看幫助信息
textEditor.help();

// 顯示版本信息
textEditor.version();

// 打開文件進行編輯
textEditor.open('path/to/file.txt', (content) => {
  // 在此處編輯內容
});

// 創建新文件
textEditor.create('newFile.txt', () => {
  console.log('文件已創建');
});

高級用法

const config = {
  port: 3001,
  logger: {
    log: console.log,
    error: console.error
  },
  middleware: [
    // 自定義中間件
    (req, res, next) => {
      console.log('請求來自:', req.ip);
      next();
    }
  ]
};

const textEditor = new TextEditorServer(config);

📚 詳細文檔

支持的 Claude 文本編輯器版本

此包實現了與 Claude 的內置文本編輯器工具 相同的功能，支持以下版本：

• text_editor_20241022（Claude 3.5 Sonnet）
• text_editor_20250124（Claude 3.7 Sonnet）

但使用工具名稱 'textEditor' 來避免與 Claude 的內置工具發生命名衝突。

🔧 技術細節

開發

安裝依賴

npm install

啟動測試服務器

npm run dev

測試

此項目使用 Vitest 進行測試。

• 運行所有測試

npm test

• 帶覆蓋率報告的測試

npm test:coverage

測試覆蓋率報告將生成在 coverage 目錄中。

📄 許可證

本項目採用 MIT 許可證。

🤝 貢獻

歡迎貢獻！請隨時提交 Pull Request。

1. 叉分倉庫
2. 創建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打開 Pull Request