Инструмент текстового редактора

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 добавить строки документации, комментарии или файлы README в вашу кодовую базу.
• Создание тестов: Попросите Claude создать модульные тесты для вашего кода на основе его понимания реализации.

​

Использование инструмента текстового редактора

Предоставьте инструмент текстового редактора (названный str_replace_editor) Claude, используя Messages API:

Инструмент текстового редактора можно использовать следующим образом:

​

Команды инструмента текстового редактора

Инструмент текстового редактора поддерживает несколько команд для просмотра и изменения файлов:

​

view

Команда view позволяет Claude изучать содержимое файла или список содержимого директории. Она может читать весь файл или определенный диапазон строк.

Параметры:

• command: Должно быть “view”
• path: Путь к файлу или директории для просмотра
• view_range (необязательно): Массив из двух целых чисел, указывающих начальный и конечный номера строк для просмотра. Номера строк начинаются с 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):
    """Заменить текст только если есть ровно одно совпадение."""
    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 для улучшения вашего рабочего процесса разработки и продуктивности.