MCP Server Text Editor

🚀 Claude テキストエディタ MCP サーバ

このプロジェクトは、Model Context Protocol (MCP) サーバのオープンソース実装です。Claude の組み込みテキストエディタツールを模倣しており、標準 API を通じてテキストファイルの閲覧、編集、作成を可能にします。

🚀 クイックスタート

Claude テキストエディタ MCP サーバを使うことで、Claude の組み込みテキストエディタツールと同じ機能を標準 API 経由で利用できます。以下の手順でサーバをセットアップし、使用を開始できます。

✨ 主な機能

• 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）

ただし、Claude の組み込みツールとの名前の衝突を避けるために、ツール名 'textEditor' を使用します。

🔧 技術詳細

開発

依存関係のインストール

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 を開く