MCP Text Editor

🚀 MCP テキストエディタ

MCP テキストエディタは、HTTP API を通じてファイルの読み取り、書き込み、更新操作を行うことができるテキストベースの協力ツールです。このツールは、リアルタイムでの協力が必要なアプリケーションシナリオ向けに設計されており、複数のユーザーが同時に同じファイルを編集でき、競合検出と解決メカニズムを提供します。

✨ 主な機能

核心機能モジュール

1. ファイル内容の取得

   • 指定されたパスからファイル内容を読み取ります。
   • 範囲（行番号）を指定して、ファイルの一部内容を取得することもできます。

2. ファイル内容の編集

   • 指定位置に内容を挿入または上書きします。
   • 一度に複数の変更をまとめて提出することができます。
   • 競合検出メカニズムを備え、並行編集によるデータ不一致を防ぎます。

3. エラー処理と復元

   • ファイルの状態変化（他のプロセスによる変更など）を検出します。
   • 競合が発生した場合、詳細なエラー情報を提供し、ユーザーが再試行または修正しやすくします。

一般的な使用シナリオ

基本的な使用法

contents = await get_text_file_contents({
    "files": [
        {
            "file_path": "file.txt",
            "ranges": [{"start": 1, "end": null}]  # ファイル全体を読み取る
        }
    ]
})

高度な使用法

result = await edit_text_file_contents({
    "files": [
        {
            "path": "file.txt",
            "hash": contents["file.txt"][0]["hash"],
            "encoding": "utf-8",  # オプション、デフォルトは "utf-8"
            "patches": [
                {
                    "line_start": 5,
                    "line_end": 8,
                    "contents": "新内容\n"
                }
            ]
        }
    ]
})

競合の処理

if result["file.txt"]["result"] == "error":
    if "hash mismatch" in result["file.txt"]["reason"]:
        # ファイルが他のプロセスによって変更された場合、最新の内容を取得して再試行する
        pass

📚 ドキュメント

エラー処理

サーバーは様々なエラー状況を処理します。

• ファイルが見つからない：すべてのファイルパスを検証し、ディレクトリトラバーサル攻撃を防止します。
• アクセス拒否：ファイルとディレクトリのアクセス権限を確認します。
• ハッシュ不一致（並行編集検出）：内容が他のプロセスによって変更されました。
• 無効なパッチ範囲：重複または範囲外の行番号です。
• エンコーディングエラー：指定されたエンコーディングでファイルをデコードできません。

セキュリティに関する注意事項

• ファイルパスの検証：サーバーはすべてのファイルパスを厳密に検証し、ディレクトリトラバーサル攻撃を防止します。
• アクセス制御：ファイルシステムのアクセス権限を適切に設定し、許可されていないアクセスを制限してください。
• ハッシュ検証：すべてのファイル変更は SHA - 256 ハッシュ値で検証され、競合状態の問題を回避します。
• 入力クリーニング：すべてのユーザー入力は厳密にクリーニングおよび検証されます。
• エラー処理：エラー情報には機密データが一切含まれません。

トラブルシューティング

一般的な問題

• アクセス拒否

  • ファイルとディレクトリのアクセス権限を確認してください。
  • 実行プロセスがターゲットファイルにアクセスするのに十分な権限を持っていることを確認してください。

• ハッシュ不一致

  • 最新の内容を取得してから、編集操作を再試行してください。
  • エラー情報を確認して、具体的な原因を把握してください。

• エンコーディング問題

  • 指定されたエンコーディングがファイルの実際のエンコーディングと一致していることを確認してください。
  • 他のエンコーディング形式を試して、ファイルを再読み込みしてください。

開発設定

依存関係のインストール

pip install requests

テストの実行

python tests.py

プロジェクト構造

mcp-text-editor/
├── README.md               # プロジェクトドキュメント
├── requirements.txt       # プロジェクトの依存関係
├── src/
│   ├── __init__.py
│   ├── client.py          # HTTP クライアントの実装
│   └── server.py          # HTTP サーバーの実装
└── tests/
    └── test_*.py         # テストケース

コード品質ツール

black .  # コードのフォーマット
flake8 .  # コードスタイルのチェック
mypy .  # 静的型チェック

テスト

単体テスト

import unittest
from src.client import MCPClient

class TestMCPClient(unittest.TestCase):
    def setUp(self):
        self.client = MCPClient('http://localhost:8000')

    def test_get_file_contents(self):
        result = self.client.get_file_contents('file.txt')
        self.assertIsInstance(result, dict)

if __name__ == '__main__':
    unittest.main()

統合テスト

import pytest
from src.server import MCPServer

def test_server_response():
    server = MCPServer()
    server.start()
    assert 200 in server.responses

貢献ガイド

コードの提出

git clone https://github.com/yourusername/mcp-text-editor.git
cd mcp-text-editor
git branch -b feature/new-feature
git add .
git commit -m "新機能の追加"
git push origin feature/new-feature

問題報告

• GitHub Issues を通じて、バグまたは機能要求を提出してください。

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。詳細は LICENSE ファイルを参照してください。