テキストエディタツール

Claudeは、Anthropicが定義したテキストエディタツールを使用して、テキストファイルを表示および修正し、コードやその他のテキストドキュメントのデバッグ、修正、改善を支援することができます。これにより、Claudeはファイルと直接やり取りし、変更を提案するだけでなく、実践的な支援を提供することができます。

​

テキストエディタツールを使用する前に

​

互換性のあるモデルを使用する

Anthropicのテキストエディタツールは、Claude 3.5 SonnetとClaude 3.7 Sonnetでのみ利用可能です：

• Claude 3.7 Sonnet: text_editor_20250124
• Claude 3.5 Sonnet: text_editor_20241022

両バージョンは同じ機能を提供します - 使用するバージョンは、作業しているモデルに合わせる必要があります。

​

ユースケースの適合性を評価する

テキストエディタツールを使用する場合の例：

• コードデバッグ: 構文エラーからロジックの問題まで、Claudeにバグの特定と修正を依頼します。
• コードリファクタリング: Claudeに対象を絞った編集を通じて、コードの構造、可読性、パフォーマンスを改善させます。
• ドキュメント生成: Claudeにコードベースのdocstring、コメント、READMEファイルの追加を依頼します。
• テスト作成: 実装の理解に基づいて、Claudeにコードのユニットテストを作成させます。

​

テキストエディタツールを使用する

Messages APIを使用してテキストエディタツール（str_replace_editorという名前）をClaudeに提供します：

テキストエディタツールは以下のように使用できます：

​

テキストエディタツールのコマンド

テキストエディタツールは、ファイルの表示と修正のために複数のコマンドをサポートしています：

​

view

viewコマンドを使用すると、Claudeはファイルの内容を確認したり、ディレクトリの内容を一覧表示したりすることができます。ファイル全体または特定の行範囲を読み取ることができます。

パラメータ：

• command: “view”でなければなりません
• path: 表示するファイルまたはディレクトリへのパス
• view_range (オプション): 表示する開始行と終了行の番号を指定する2つの整数の配列。行番号は1から始まり、終了行に-1を指定するとファイルの最後まで読み取ります。このパラメータはディレクトリではなく、ファイルの表示時のみ適用されます。

// ファイルを表示する例
{
  "type": "tool_use",
  "id": "toolu_01A09q90qw90lq917835lq9",
  "name": "str_replace_editor",
  "input": {
    "command": "view",
    "path": "primes.py"
  }
}

// ディレクトリを表示する例
{
  "type": "tool_use",
  "id": "toolu_02B19r91rw91mr917835mr9",
  "name": "str_replace_editor",
  "input": {
    "command": "view",
    "path": "src/"
  }
}

​

str_replace

str_replaceコマンドを使用すると、Claudeはファイル内の特定の文字列を新しい文字列に置き換えることができます。これは正確な編集を行うために使用されます。

パラメータ：

• command: “str_replace”でなければなりません
• path: 修正するファイルへのパス
• old_str: 置き換えるテキスト（空白やインデントを含めて正確に一致する必要があります）
• new_str: 古いテキストの代わりに挿入する新しいテキスト

{
  "type": "tool_use",
  "id": "toolu_01A09q90qw90lq917835lq9",
  "name": "str_replace_editor",
  "input": {
    "command": "str_replace",
    "path": "primes.py",
    "old_str": "for num in range(2, limit + 1)",
    "new_str": "for num in range(2, limit + 1):"
  }
}

​

create

createコマンドを使用すると、Claudeは指定された内容で新しいファイルを作成することができます。

パラメータ：

• command: “create”でなければなりません
• path: 新しいファイルを作成するパス
• file_text: 新しいファイルに書き込む内容

{
  "type": "tool_use",
  "id": "toolu_01A09q90qw90lq917835lq9",
  "name": "str_replace_editor",
  "input": {
    "command": "create",
    "path": "test_primes.py",
    "file_text": "import unittest\nimport primes\n\nclass TestPrimes(unittest.TestCase):\n    def test_is_prime(self):\n        self.assertTrue(primes.is_prime(2))\n        self.assertTrue(primes.is_prime(3))\n        self.assertFalse(primes.is_prime(4))\n\nif __name__ == '__main__':\n    unittest.main()"
  }
}

​

insert

insertコマンドを使用すると、Claudeはファイル内の特定の位置にテキストを挿入することができます。

パラメータ：

• command: “insert”でなければなりません
• path: 修正するファイルへのパス
• insert_line: テキストを挿入する行番号（ファイルの先頭の場合は0）
• new_str: 挿入するテキスト

{
  "type": "tool_use",
  "id": "toolu_01A09q90qw90lq917835lq9",
  "name": "str_replace_editor",
  "input": {
    "command": "insert",
    "path": "primes.py",
    "insert_line": 0,
    "new_str": "\"\"\"Module for working with prime numbers.\n\nThis module provides functions to check if a number is prime\nand to generate a list of prime numbers up to a given limit.\n\"\"\"\n"
  }
}

​

undo_edit

undo_editコマンドを使用すると、Claudeはファイルに対する最後の編集を元に戻すことができます。

パラメータ：

• command: “undo_edit”でなければなりません
• path: 最後の編集を元に戻すファイルへのパス

{
  "type": "tool_use",
  "id": "toolu_01A09q90qw90lq917835lq9",
  "name": "str_replace_editor",
  "input": {
    "command": "undo_edit",
    "path": "primes.py"
  }
}

​

例：テキストエディタツールを使用した構文エラーの修正

この例では、Claudeがテキストエディタツールを使用してPythonファイルの構文エラーを修正する方法を示します。

まず、アプリケーションはClaudeにテキストエディタツールと構文エラーを修正するためのプロンプトを提供します：

Claudeはまずテキストエディタツールを使用してファイルを表示します：

{
  "id": "msg_01XAbCDeFgHiJkLmNoPQrStU",
  "model": "claude-3-7-sonnet-20250219",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "I'll help you fix the syntax error in your primes.py file. First, let me take a look at the file to identify the issue."
    },
    {
      "type": "tool_use",
      "id": "toolu_01AbCdEfGhIjKlMnOpQrStU",
      "name": "str_replace_editor",
      "input": {
        "command": "view",
        "path": "primes.py"
      }
    }
  ]
}

アプリケーションはファイルを読み取り、その内容をClaudeに返す必要があります：

Claudeは構文エラーを特定し、str_replaceコマンドを使用して修正します：

{
  "id": "msg_01VwXyZAbCdEfGhIjKlMnO",
  "model": "claude-3-7-sonnet-20250219",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "I found the syntax error in your primes.py file. In the `get_primes` function, there is a missing colon (:) at the end of the for loop line. Let me fix that for you."
    },
    {
      "type": "tool_use",
      "id": "toolu_01PqRsTuVwXyZAbCdEfGh",
      "name": "str_replace_editor",
      "input": {
        "command": "str_replace",
        "path": "primes.py",
        "old_str": "    for num in range(2, limit + 1)",
        "new_str": "    for num in range(2, limit + 1):"
      }
    }
  ]
}

アプリケーションは編集を行い、結果を返す必要があります：

最後に、Claudeは修正の完全な説明を提供します：

{
  "id": "msg_01IjKlMnOpQrStUvWxYzAb",
  "model": "claude-3-7-sonnet-20250219",
  "stop_reason": "end_turn",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "I've fixed the syntax error in your primes.py file. The issue was in the `get_primes` function at line 19. There was a missing colon (:) at the end of the for loop line.\n\nHere's what I changed:\n\nFrom:\n```python\nfor num in range(2, limit + 1)\n```\n\nTo:\n```python\nfor num in range(2, limit + 1):\n```\n\nIn Python, a colon is required at the end of statements that start a new code block, such as for loops, if statements, function definitions, etc. Without the colon, Python raises a syntax error because it doesn't know where the code block begins.\n\nYour code should now run correctly. The function will properly generate a list of prime numbers up to the specified limit."
    }
  ]
}

​

テキストエディタツールを実装する

テキストエディタツールは、type: "text_editor_20250124"で識別されるスキーマレスツールとして実装されています。このツールを使用する際、他のツールのように入力スキーマを提供する必要はありません。スキーマはClaudeのモデルに組み込まれており、変更することはできません。

def handle_editor_tool(tool_call):
    input_params = tool_call.input
    command = input_params.get('command', '')
    file_path = input_params.get('path', '')
    
    if command == 'view':
        # ファイルの内容を読み取って返す
        pass
    elif command == 'str_replace':
        # ファイル内のテキストを置換する
        pass
    elif command == 'create':
        # 新しいファイルを作成する
        pass
    elif command == 'insert':
        # 指定位置にテキストを挿入する
        pass
    elif command == 'undo_edit':
        # バックアップから復元する
        pass

# Claudeのレスポンス内のツール使用を処理する
for content in response.content:
    if content.type == "tool_use":
        # コマンドに基づいてツールを実行する
        result = handle_editor_tool(content)
        
        # 結果をClaudeに返す
        tool_result = {
            "type": "tool_result",
            "tool_use_id": content.id,
            "content": result
        }

​

エラーの処理

テキストエディタツールを使用する際、さまざまなエラーが発生する可能性があります。以下は、それらを処理する方法についてのガイダンスです：

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "Error: File not found",
      "is_error": true
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "Error: Found 3 matches for replacement text. Please provide more context to make a unique match.",
      "is_error": true
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "Error: No match found for replacement. Please check your text and try again.",
      "is_error": true
    }
  ]
}

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "Error: Permission denied. Cannot write to file.",
      "is_error": true
    }
  ]
}

​

実装のベストプラクティスに従う

def backup_file(file_path):
    """編集前にファイルのバックアップを作成する。"""
    backup_path = f"{file_path}.backup"
    if os.path.exists(file_path):
        with open(file_path, 'r') as src, open(backup_path, 'w') as dst:
            dst.write(src.read())

def safe_replace(file_path, old_text, new_text):
    """正確に1箇所に一致する場合のみテキストを置換する。"""
    with open(file_path, 'r') as f:
        content = f.read()
    
    count = content.count(old_text)
    if count == 0:
        return "Error: No match found"
    elif count > 1:
        return f"Error: Found {count} matches"
    else:
        new_content = content.replace(old_text, new_text)
        with open(file_path, 'w') as f:
            f.write(new_content)
        return "Successfully replaced text"

def verify_changes(file_path):
    """変更後にテストまたはチェックを実行する。"""
    try:
        # Pythonファイルの場合、構文エラーをチェックする
        if file_path.endswith('.py'):
            import ast
            with open(file_path, 'r') as f:
                ast.parse(f.read())
            return "Syntax check passed"
    except Exception as e:
        return f"Verification failed: {str(e)}"

​

価格とトークン使用量

テキストエディタツールは、Claudeで使用される他のツールと同じ価格構造を使用します。使用しているClaudeモデルに基づく標準的な入力および出力トークンの価格に従います。

基本トークンに加えて、テキストエディタツールには以下の追加入力トークンが必要です：

ツールの価格に関する詳細な情報については、ツール使用の価格設定を参照してください。

​

テキストエディタツールをコンピュータ使用と統合する

テキストエディタツールは、コンピュータ使用ツールや他のAnthropicが定義したツールと併用することができます。これらのツールを組み合わせる際は、以下の点に注意する必要があります：

1. 適切なベータヘッダーを含める（コンピュータ使用と併用する場合）
2. ツールのバージョンを使用するモデルに合わせる
3. リクエストに含まれるすべてのツールの追加トークン使用量を考慮する

コンピュータ使用のコンテキストでテキストエディタツールを使用する方法の詳細については、コンピュータ使用を参照してください。

​

変更履歴

​

次のステップ

テキストエディタツールをより便利で強力な方法で使用するためのアイデアをいくつか紹介します：

• 開発ワークフローへの統合: テキストエディタツールを開発ツールやIDEに組み込む
• コードレビューシステムの作成: Claudeにコードをレビューさせ、改善を加えさせる
• デバッグアシスタントの構築: Claudeがコードの問題を診断して修正するのを助けるシステムを作成する
• ファイル形式変換の実装: Claudeにファイルを別の形式に変換する手助けをさせる
• ドキュメント自動化: Claudeが自動的にコードをドキュメント化するワークフローを設定する

テキストエディタツールを使用してアプリケーションを構築する際、Claudeの機能を活用して開発ワークフローと生産性を向上させる方法を見るのが楽しみです。