文本编辑器工具

Claude可以使用Anthropic定义的文本编辑器工具来查看和修改文本文件，帮助您调试、修复和改进代码或其他文本文档。这使Claude能够直接与您的文件交互，提供实际操作的帮助，而不仅仅是建议更改。

使用文本编辑器工具之前

使用兼容的模型

Anthropic的文本编辑器工具适用于多个Claude模型：

Claude 4 Opus & Sonnet: text_editor_20250728
Claude Sonnet 3.7: text_editor_20250124
Claude Sonnet 3.5: text_editor_20241022

Claude Sonnet 3.5在使用文本编辑器工具时需要computer-use-2024-10-22测试版标头。

文本编辑器工具在Claude 4和Sonnet 3.7中普遍可用。

Claude 4模型的text_editor_20250728工具不包含undo_edit命令。如果您需要此功能，您需要使用Claude 3.7或Sonnet 3.5及其相应的工具版本。

评估您的用例适配性

使用文本编辑器工具的一些示例包括：

代码调试：让Claude识别并修复代码中的错误，从语法错误到逻辑问题。
代码重构：让Claude通过有针对性的编辑改进代码结构、可读性和性能。
文档生成：要求Claude为您的代码库添加文档字符串、注释或README文件。
测试创建：让Claude根据对实现的理解为您的代码创建单元测试。

使用文本编辑器工具

使用Messages API向Claude提供文本编辑器工具（名为str_replace_based_edit_tool）。

您可以选择指定max_characters参数来控制查看大文件时的截断。

max_characters仅与text_editor_20250728及更高版本的文本编辑器工具兼容。

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-opus-4-20250514",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20250728",
        "name": "str_replace_based_edit_tool",
        "max_characters": 10000
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      }
    ]
  }'

使用Messages API向Claude提供文本编辑器工具（名为str_replace_based_edit_tool）。

您可以选择指定max_characters参数来控制查看大文件时的截断。

max_characters仅与text_editor_20250728及更高版本的文本编辑器工具兼容。

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-opus-4-20250514",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20250728",
        "name": "str_replace_based_edit_tool",
        "max_characters": 10000
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      }
    ]
  }'

使用Messages API向Claude提供文本编辑器工具（名为str_replace_editor）：

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-3-7-sonnet-20250219",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20250124",
        "name": "str_replace_editor"
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      }
    ]
  }'

使用Messages API向Claude提供文本编辑器工具（名为str_replace_editor）：

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "anthropic-beta: computer-use-2024-10-22" \
  -d '{
    "model": "claude-3-5-sonnet-20241022",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20241022",
        "name": "str_replace_editor"
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      }
    ]
  }'

文本编辑器工具可以按以下方式使用：

为Claude提供文本编辑器工具和用户提示

在您的API请求中包含文本编辑器工具
提供可能需要检查或修改文件的用户提示，例如”您能修复我代码中的语法错误吗？”

Claude使用工具检查文件或目录

Claude评估需要查看的内容，并使用view命令检查文件内容或列出目录内容
API响应将包含带有view命令的tool_use内容块

执行view命令并返回结果

从Claude的工具使用请求中提取文件或目录路径
读取文件内容或列出目录内容
如果在工具配置中指定了max_characters参数，则将文件内容截断到该长度
通过继续对话并发送包含tool_result内容块的新user消息将结果返回给Claude

Claude使用工具修改文件

检查文件或目录后，Claude可能使用诸如str_replace之类的命令进行更改，或使用insert在特定行号添加文本。
如果Claude使用str_replace命令，Claude会构造一个格式正确的工具使用请求，包含要替换的旧文本和新文本

执行编辑并返回结果

从Claude的工具使用请求中提取文件路径、旧文本和新文本
在文件中执行文本替换
将结果返回给Claude

Claude提供分析和解释

检查并可能编辑文件后，Claude提供关于发现内容和所做更改的完整解释

文本编辑器工具命令

文本编辑器工具支持多个用于查看和修改文件的命令：

view

view命令允许Claude检查文件内容或列出目录内容。它可以读取整个文件或特定行范围。

参数：

command：必须是”view”
path：要查看的文件或目录的路径
view_range（可选）：指定要查看的开始和结束行号的两个整数数组。行号从1开始索引，结束行的-1表示读取到文件末尾。此参数仅在查看文件时适用，不适用于目录。

view命令示例

// 查看文件的示例
{
  "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：要插入以替代旧文本的新文本

str_replace命令示例

{
  "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：要写入新文件的内容

create命令示例

{
  "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：要插入的文本

insert命令示例

{
  "type": "tool_use",
  "id": "toolu_01A09q90qw90lq917835lq9",
  "name": "str_replace_editor",
  "input": {
    "command": "insert",
    "path": "primes.py",
    "insert_line": 0,
    "new_str": "\"\"\"用于处理质数的模块。\n\n此模块提供检查数字是否为质数的函数\n以及生成给定限制内质数列表的函数。\n\"\"\"\n"
  }
}

undo_edit

undo_edit命令允许Claude撤销对文件所做的最后一次编辑。

此命令仅在Claude Sonnet 3.7和Claude Sonnet 3.5中可用。使用text_editor_20250728的Claude 4模型不支持此命令。

参数：

command：必须是”undo_edit”
path：应撤销最后一次编辑的文件路径

undo_edit命令示例

示例：使用文本编辑器工具修复语法错误

此示例演示了Claude 4如何使用文本编辑器工具修复Python文件中的语法错误。

首先，您的应用程序为Claude提供文本编辑器工具和修复语法错误的提示：

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-opus-4-20250514",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20250728",
        "name": "str_replace_based_edit_tool"
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      }
    ]
  }'

Claude将首先使用文本编辑器工具查看文件：

{
  "id": "msg_01XAbCDeFgHiJkLmNoPQrStU",
  "model": "claude-opus-4-20250514",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "我将帮助您修复primes.py文件中的语法错误。首先，让我查看文件以识别问题。"
    },
    {
      "type": "tool_use",
      "id": "toolu_01AbCdEfGhIjKlMnOpQrStU",
      "name": "str_replace_based_edit_tool",
      "input": {
        "command": "view",
        "path": "primes.py"
      }
    }
  ]
}

然后您的应用程序应该读取文件并将其内容返回给Claude：

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-opus-4-20250514",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20250728",
        "name": "str_replace_based_edit_tool"
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      },
      {
            "role": "assistant",
            "content": [
                {
                    "type": "text",
                    "text": "我将帮助您修复primes.py文件中的语法错误。首先，让我查看文件以识别问题。"
                },
                {
                    "type": "tool_use",
                    "id": "toolu_01AbCdEfGhIjKlMnOpQrStU",
                    "name": "str_replace_based_edit_tool",
                    "input": {
                        "command": "view",
                        "path": "primes.py"
                    }
                }
            ]
        },
        {
            "role": "user",
            "content": [
                {
                    "type": "tool_result",
                    "tool_use_id": "toolu_01AbCdEfGhIjKlMnOpQrStU",
                    "content": "1: def is_prime(n):\n2:     \"\"\"检查数字是否为质数。\"\"\"\n3:     if n <= 1:\n4:         return False\n5:     if n <= 3:\n6:         return True\n7:     if n % 2 == 0 or n % 3 == 0:\n8:         return False\n9:     i = 5\n10:     while i * i <= n:\n11:         if n % i == 0 or n % (i + 2) == 0:\n12:             return False\n13:         i += 6\n14:     return True\n15: \n16: def get_primes(limit):\n17:     \"\"\"生成给定限制内的质数列表。\"\"\"\n18:     primes = []\n19:     for num in range(2, limit + 1)\n20:         if is_prime(num):\n21:             primes.append(num)\n22:     return primes\n23: \n24: def main():\n25:     \"\"\"演示质数生成的主函数。\"\"\"\n26:     limit = 100\n27:     prime_list = get_primes(limit)\n28:     print(f\"质数到{limit}:\")\n29:     print(prime_list)\n30:     print(f\"找到{len(prime_list)}个质数。\")\n31: \n32: if __name__ == \"__main__\":\n33:     main()"
                }
            ]
        }
    ]
  }'

行号

在上面的示例中，view工具结果包含带有行号前缀的文件内容（例如，“1: def is_prime(n):”）。行号不是必需的，但对于成功使用view_range参数检查文件的特定部分和insert_line参数在精确位置添加内容至关重要。

Claude将识别语法错误并使用str_replace命令修复它：

{
  "id": "msg_01VwXyZAbCdEfGhIjKlMnO",
  "model": "claude-opus-4-20250514",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "我在您的primes.py文件中发现了语法错误。在`get_primes`函数中，for循环行末尾缺少冒号（:）。让我为您修复这个问题。"
    },
    {
      "type": "tool_use",
      "id": "toolu_01PqRsTuVwXyZAbCdEfGh",
      "name": "str_replace_based_edit_tool",
      "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):"
      }
    }
  ]
}

然后您的应用程序应该进行编辑并返回结果：

response = client.messages.create(
    model="claude-opus-4-20250514",
    max_tokens=1024,
    tools=[
        {
            "type": "text_editor_20250728",
            "name": "str_replace_based_edit_tool"
        }
    ],
    messages=[
        # 之前的消息...
        {
            "role": "assistant",
            "content": [
                {
                    "type": "text",
                    "text": "我在您的primes.py文件中发现了语法错误。在`get_primes`函数中，for循环行末尾缺少冒号（:）。让我为您修复这个问题。"
                },
                {
                    "type": "tool_use",
                    "id": "toolu_01PqRsTuVwXyZAbCdEfGh",
                    "name": "str_replace_based_edit_tool",
                    "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):"
                    }
                }
            ]
        },
        {
            "role": "user",
            "content": [
                {
                    "type": "tool_result",
                    "tool_use_id": "toolu_01PqRsTuVwXyZAbCdEfGh",
                    "content": "成功在一个位置替换了文本。"
                }
            ]
        }
    ]
)

最后，Claude将提供修复的完整解释：

{
  "id": "msg_01IjKlMnOpQrStUvWxYzAb",
  "model": "claude-opus-4-20250514",
  "stop_reason": "end_turn",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "我已经修复了您的primes.py文件中的语法错误。问题出现在第19行的`get_primes`函数中。for循环行末尾缺少冒号（:）。\n\n以下是我所做的更改：\n\n从：\n```python\nfor num in range(2, limit + 1)\n```\n\n到：\n```python\nfor num in range(2, limit + 1):\n```\n\n在Python中，开始新代码块的语句（如for循环、if语句、函数定义等）末尾需要冒号。没有冒号，Python会引发语法错误，因为它不知道代码块从哪里开始。\n\n您的代码现在应该能正确运行。该函数将正确生成指定限制内的质数列表。"
    }
  ]
}

此示例演示了Claude 4如何使用文本编辑器工具修复Python文件中的语法错误。

首先，您的应用程序为Claude提供文本编辑器工具和修复语法错误的提示：

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-opus-4-20250514",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20250728",
        "name": "str_replace_based_edit_tool"
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      }
    ]
  }'

Claude将首先使用文本编辑器工具查看文件：

{
  "id": "msg_01XAbCDeFgHiJkLmNoPQrStU",
  "model": "claude-opus-4-20250514",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "我将帮助您修复primes.py文件中的语法错误。首先，让我查看文件以识别问题。"
    },
    {
      "type": "tool_use",
      "id": "toolu_01AbCdEfGhIjKlMnOpQrStU",
      "name": "str_replace_based_edit_tool",
      "input": {
        "command": "view",
        "path": "primes.py"
      }
    }
  ]
}

然后您的应用程序应该读取文件并将其内容返回给Claude：

curl https://api.anthropic.com/v1/messages \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-opus-4-20250514",
    "max_tokens": 1024,
    "tools": [
      {
        "type": "text_editor_20250728",
        "name": "str_replace_based_edit_tool"
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
      },
      {
            "role": "assistant",
            "content": [
                {
                    "type": "text",
                    "text": "我将帮助您修复primes.py文件中的语法错误。首先，让我查看文件以识别问题。"
                },
                {
                    "type": "tool_use",
                    "id": "toolu_01AbCdEfGhIjKlMnOpQrStU",
                    "name": "str_replace_based_edit_tool",
                    "input": {
                        "command": "view",
                        "path": "primes.py"
                    }
                }
            ]
        },
        {
            "role": "user",
            "content": [
                {
                    "type": "tool_result",
                    "tool_use_id": "toolu_01AbCdEfGhIjKlMnOpQrStU",
                    "content": "1: def is_prime(n):\n2:     \"\"\"检查数字是否为质数。\"\"\"\n3:     if n <= 1:\n4:         return False\n5:     if n <= 3:\n6:         return True\n7:     if n % 2 == 0 or n % 3 == 0:\n8:         return False\n9:     i = 5\n10:     while i * i <= n:\n11:         if n % i == 0 or n % (i + 2) == 0:\n12:             return False\n13:         i += 6\n14:     return True\n15: \n16: def get_primes(limit):\n17:     \"\"\"生成给定限制内的质数列表。\"\"\"\n18:     primes = []\n19:     for num in range(2, limit + 1)\n20:         if is_prime(num):\n21:             primes.append(num)\n22:     return primes\n23: \n24: def main():\n25:     \"\"\"演示质数生成的主函数。\"\"\"\n26:     limit = 100\n27:     prime_list = get_primes(limit)\n28:     print(f\"质数到{limit}:\")\n29:     print(prime_list)\n30:     print(f\"找到{len(prime_list)}个质数。\")\n31: \n32: if __name__ == \"__main__\":\n33:     main()"
                }
            ]
        }
    ]
  }'

行号

Claude将识别语法错误并使用str_replace命令修复它：

{
  "id": "msg_01VwXyZAbCdEfGhIjKlMnO",
  "model": "claude-opus-4-20250514",
  "stop_reason": "tool_use",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "我在您的primes.py文件中发现了语法错误。在`get_primes`函数中，for循环行末尾缺少冒号（:）。让我为您修复这个问题。"
    },
    {
      "type": "tool_use",
      "id": "toolu_01PqRsTuVwXyZAbCdEfGh",
      "name": "str_replace_based_edit_tool",
      "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):"
      }
    }
  ]
}

然后您的应用程序应该进行编辑并返回结果：

response = client.messages.create(
    model="claude-opus-4-20250514",
    max_tokens=1024,
    tools=[
        {
            "type": "text_editor_20250728",
            "name": "str_replace_based_edit_tool"
        }
    ],
    messages=[
        # 之前的消息...
        {
            "role": "assistant",
            "content": [
                {
                    "type": "text",
                    "text": "我在您的primes.py文件中发现了语法错误。在`get_primes`函数中，for循环行末尾缺少冒号（:）。让我为您修复这个问题。"
                },
                {
                    "type": "tool_use",
                    "id": "toolu_01PqRsTuVwXyZAbCdEfGh",
                    "name": "str_replace_based_edit_tool",
                    "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):"
                    }
                }
            ]
        },
        {
            "role": "user",
            "content": [
                {
                    "type": "tool_result",
                    "tool_use_id": "toolu_01PqRsTuVwXyZAbCdEfGh",
                    "content": "成功在一个位置替换了文本。"
                }
            ]
        }
    ]
)

最后，Claude将提供修复的完整解释：

{
  "id": "msg_01IjKlMnOpQrStUvWxYzAb",
  "model": "claude-opus-4-20250514",
  "stop_reason": "end_turn",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "我已经修复了您的primes.py文件中的语法错误。问题出现在第19行的`get_primes`函数中。for循环行末尾缺少冒号（:）。\n\n以下是我所做的更改：\n\n从：\n```python\nfor num in range(2, limit + 1)\n```\n\n到：\n```python\nfor num in range(2, limit + 1):\n```\n\n在Python中，开始新代码块的语句（如for循环、if语句、函数定义等）末尾需要冒号。没有冒号，Python会引发语法错误，因为它不知道代码块从哪里开始。\n\n您的代码现在应该能正确运行。该函数将正确生成指定限制内的质数列表。"
    }
  ]
}

此示例演示了Claude Sonnet 3.7如何使用文本编辑器工具修复Python文件中的语法错误。

首先，您的应用程序为Claude提供文本编辑器工具和修复语法错误的提示：

import anthropic

client = anthropic.Anthropic()

response = client.messages.create(
    model="claude-3-7-sonnet-20250219",
    max_tokens=1024,
    tools=[
        {
            "type": "text_editor_20250124",
            "name": "str_replace_editor"
        }
    ],
    messages=[
        {
            "role": "user", 
            "content": "我的primes.py文件中有语法错误。您能帮我修复吗？"
        }
    ]
)

print(response)

Claude Sonnet 3.7示例遵循与上面Claude 4示例相同的格式，使用相同的工具调用和响应，但使用text_editor_20250124工具类型和str_replace_editor名称。

实现文本编辑器工具

文本编辑器工具作为无模式工具实现。使用此工具时，您不需要像其他工具那样提供输入模式；模式内置于Claude的模型中，无法修改。

工具类型取决于模型版本：

Claude 4: type: "text_editor_20250728"
Claude Sonnet 3.7: type: "text_editor_20250124"
Claude Sonnet 3.5: type: "text_editor_20241022"

初始化您的编辑器实现

创建辅助函数来处理文件操作，如读取、写入和修改文件。考虑实现备份功能以从错误中恢复。

处理编辑器工具调用

创建一个根据命令类型处理Claude工具调用的函数：

def handle_editor_tool(tool_call, model_version):
    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':
        # 检查是否为Claude 4模型
        if 'str_replace_based_edit_tool' in model_version:
            return {"error": "Claude 4不支持undo_edit命令"}
        # 为Claude 3.7/3.5从备份恢复
        pass

实施安全措施

添加验证和安全检查：

验证文件路径以防止目录遍历
在进行更改前创建备份
优雅地处理错误
实施权限检查

处理Claude的响应

从Claude的响应中提取和处理工具调用：

# 处理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
        }

实现文本编辑器工具时，请记住：

安全性：该工具可以访问您的本地文件系统，因此请实施适当的安全措施。
备份：在允许编辑重要文件之前，始终创建备份。
验证：验证所有输入以防止意外更改。
唯一匹配：确保替换完全匹配一个位置以避免意外编辑。

处理错误

使用文本编辑器工具时，可能会发生各种错误。以下是处理它们的指导：

文件未找到

如果Claude尝试查看或修改不存在的文件，在tool_result中返回适当的错误消息：

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "错误：文件未找到",
      "is_error": true
    }
  ]
}

替换的多个匹配

如果Claude的str_replace命令在文件中匹配多个位置，返回适当的错误消息：

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "错误：找到3个替换文本匹配。请提供更多上下文以进行唯一匹配。",
      "is_error": true
    }
  ]
}

替换无匹配

如果Claude的str_replace命令在文件中不匹配任何文本，返回适当的错误消息：

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "错误：未找到替换匹配。请检查您的文本并重试。",
      "is_error": true
    }
  ]
}

权限错误

如果在创建、读取或修改文件时出现权限问题，返回适当的错误消息：

{
  "role": "user",
  "content": [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01A09q90qw90lq917835lq9",
      "content": "错误：权限被拒绝。无法写入文件。",
      "is_error": true
    }
  ]
}

遵循实施最佳实践

提供清晰的上下文

明确文件路径

编辑前创建备份

在您的应用程序中实施备份系统，在允许Claude编辑文件之前创建文件副本，特别是对于重要或生产代码。

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())

小心处理唯一文本替换

str_replace命令需要要替换的文本的精确匹配。您的应用程序应确保旧文本只有一个匹配，或提供适当的错误消息。

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 "错误：未找到匹配"
    elif count > 1:
        return f"错误：找到{count}个匹配"
    else:
        new_content = content.replace(old_text, new_text)
        with open(file_path, 'w') as f:
            f.write(new_content)
        return "成功替换文本"

验证更改

Claude对文件进行更改后，通过运行测试或检查代码是否仍按预期工作来验证更改。

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 "语法检查通过"
    except Exception as e:
        return f"验证失败：{str(e)}"

定价和令牌使用

The text editor tool uses the same pricing structure as other tools used with Claude. It follows the standard input and output token pricing based on the Claude model you’re using.

In addition to the base tokens, the following additional input tokens are needed for the text editor tool:

Tool	Additional input tokens
`text_editor_20250429` (Claude 4)	700 tokens
`text_editor_20250124` (Claude Sonnet 3.7)	700 tokens
`text_editor_20241022` (Claude Sonnet 3.5 (deprecated))	700 tokens

有关工具定价的更详细信息，请参阅工具使用定价。

将文本编辑器工具与其他工具集成

文本编辑器工具可以与其他Claude工具一起使用。组合工具时，请确保：

将工具版本与您使用的模型匹配
考虑请求中包含的所有工具的额外令牌使用

更改日志

日期	版本	更改
2025年7月28日	`text_editor_20250728`	发布更新的文本编辑器工具，修复了一些问题并添加了可选的`max_characters`参数。除此之外与`text_editor_20250429`相同。
2025年4月29日	`text_editor_20250429`	发布Claude 4的文本编辑器工具。此版本删除了`undo_edit`命令，但保持所有其他功能。工具名称已更新以反映其基于str_replace的架构。
2025年3月13日	`text_editor_20250124`	引入独立的文本编辑器工具文档。此版本针对Claude Sonnet 3.7进行了优化，但具有与之前版本相同的功能。
2024年10月22日	`text_editor_20241022`	与Claude Sonnet 3.5一起初始发布文本编辑器工具。通过`view`、`create`、`str_replace`、`insert`和`undo_edit`命令提供查看、创建和编辑文件的功能。

下一步

以下是一些如何以更方便和强大的方式使用文本编辑器工具的想法：

与您的开发工作流程集成：将文本编辑器工具构建到您的开发工具或IDE中
创建代码审查系统：让Claude审查您的代码并进行改进
构建调试助手：创建一个系统，让Claude帮助您诊断和修复代码中的问题
实现文件格式转换：让Claude帮助您将文件从一种格式转换为另一种格式
自动化文档：为Claude自动记录您的代码设置工作流程

在使用文本编辑器工具构建应用程序时，我们很兴奋看到您如何利用Claude的功能来增强您的开发工作流程和生产力。

工具使用概述

了解如何实现与Claude一起使用的工具工作流程。

令牌高效的工具使用

在使用Claude Sonnet 3.7工具时减少延迟和成本。

Bash工具

使用Claude执行shell命令。

计算机使用工具网络搜索工具

On this page

使用文本编辑器工具之前
使用兼容的模型
评估您的用例适配性
使用文本编辑器工具
文本编辑器工具命令
view
str_replace
create
insert
undo_edit
示例：使用文本编辑器工具修复语法错误
实现文本编辑器工具
处理错误
遵循实施最佳实践
定价和令牌使用
将文本编辑器工具与其他工具集成
更改日志
下一步

入门步骤

模型与定价

了解 Claude

功能

工具

模型上下文协议 (MCP)

使用案例

提示工程

测试与评估

加强防护措施

法律中心

文本编辑器工具

使用文本编辑器工具之前

使用兼容的模型

评估您的用例适配性

使用文本编辑器工具

文本编辑器工具命令

view

str_replace

create

insert

undo_edit

示例：使用文本编辑器工具修复语法错误

实现文本编辑器工具

处理错误

遵循实施最佳实践

定价和令牌使用

将文本编辑器工具与其他工具集成

更改日志

下一步

工具使用概述

令牌高效的工具使用

Bash工具

入门步骤

模型与定价

了解 Claude

功能

工具

模型上下文协议 (MCP)

使用案例

提示工程

测试与评估

加强防护措施

法律中心

​使用文本编辑器工具之前

​使用兼容的模型

​评估您的用例适配性

​使用文本编辑器工具

​文本编辑器工具命令

​view

​str_replace

​create

​insert

​undo_edit

​示例：使用文本编辑器工具修复语法错误

​实现文本编辑器工具

​处理错误

​遵循实施最佳实践

​定价和令牌使用

​将文本编辑器工具与其他工具集成

​更改日志

​下一步

工具使用概述

令牌高效的工具使用

Bash工具

使用文本编辑器工具之前

使用兼容的模型

评估您的用例适配性

使用文本编辑器工具

文本编辑器工具命令

view

str_replace

create

insert

undo_edit

示例：使用文本编辑器工具修复语法错误

实现文本编辑器工具

处理错误

遵循实施最佳实践

定价和令牌使用

将文本编辑器工具与其他工具集成

更改日志

下一步