工具

文本编辑器工具

Claude 可以使用 Anthropic 定义的文本编辑器工具来查看和修改文本文件，帮助您调试、修复和改进代码或其他文本文档。

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

模型兼容性

模型	工具版本
Claude 4.x 模型	`text_editor_20250728`
Claude Sonnet 3.7 (已弃用)	`text_editor_20250124`

Claude 4 模型的 text_editor_20250728 工具不包括 undo_edit 命令。如果您需要此功能，您需要使用 Claude Sonnet 3.7 (已弃用)。

较旧的工具版本不保证与较新的模型向后兼容。始终使用与您的模型版本相对应的工具版本。

何时使用文本编辑器工具

以下是何时使用文本编辑器工具的一些示例：

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

使用文本编辑器工具

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

1
向 Claude 提供文本编辑器工具和用户提示
- 在您的 API 请求中包含文本编辑器工具
- 提供可能需要检查或修改文件的用户提示，例如"您能修复我代码中的语法错误吗？"
2
Claude 使用工具检查文件或目录
- Claude 评估需要查看的内容，并使用 view 命令检查文件内容或列出目录内容
- API 响应将包含带有 view 命令的 tool_use 内容块
3
执行 view 命令并返回结果
- 从 Claude 的工具使用请求中提取文件或目录路径
- 读取文件的内容或列出目录内容
- 如果在工具配置中指定了 max_characters 参数，请将文件内容截断到该长度
- 通过继续对话并返回包含 tool_result 内容块的新 user 消息将结果返回给 Claude
4
Claude 使用工具修改文件
- 检查文件或目录后，Claude 可能会使用 str_replace 等命令进行更改或使用 insert 在特定行号处添加文本。
- 如果 Claude 使用 str_replace 命令，Claude 会构造一个格式正确的工具使用请求，其中包含旧文本和新文本以替换它
5
执行编辑并返回结果
- 从 Claude 的工具使用请求中提取文件路径、旧文本和新文本
- 在文件中执行文本替换
- 将结果返回给 Claude
6
Claude 提供其分析和解释
- 检查并可能编辑文件后，Claude 提供其发现内容和所做更改的完整解释

文本编辑器工具命令

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

view

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

参数：

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

str_replace

str_replace 命令允许 Claude 用新字符串替换文件中的特定字符串。这用于进行精确编辑。

参数：

command：必须为 "str_replace"
path：要修改的文件的路径
old_str：要替换的文本（必须完全匹配，包括空格和缩进）
new_str：要插入以替换旧文本的新文本

create

create 命令允许 Claude 创建具有指定内容的新文件。

参数：

command：必须为 "create"
path：应创建新文件的路径
file_text：要写入新文件的内容

insert

insert 命令允许 Claude 在文件中的特定位置插入文本。

参数：

command：必须为 "insert"
path：要修改的文件的路径
insert_line：要在其后插入文本的行号（0 表示文件开头）
new_str：要插入的文本

undo_edit

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

此命令仅在 Claude Sonnet 3.7 (已弃用) 中可用。Claude 4 模型使用 text_editor_20250728 不支持此命令。

参数：

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

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

实现文本编辑器工具

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

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

Claude 4：type: "text_editor_20250728"
Claude Sonnet 3.7：type: "text_editor_20250124"

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

处理编辑器工具调用

创建一个函数来处理来自 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": "undo_edit command is not supported in Claude 4"}
        # 为 Claude 3.7 从备份恢复
        pass

3
实现安全措施
添加验证和安全检查：
- 验证文件路径以防止目录遍历
- 在进行更改前创建备份
- 优雅地处理错误
- 实现权限检查

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

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

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

处理错误

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

遵循实现最佳实践

定价和令牌使用

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.x)	700 tokens
`text_editor_20250124` (Claude Sonnet 3.7 (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 命令。

工具

文本编辑器工具

Claude 可以使用 Anthropic 定义的文本编辑器工具来查看和修改文本文件，帮助您调试、修复和改进代码或其他文本文档。

模型兼容性

模型	工具版本
Claude 4.x 模型	`text_editor_20250728`
Claude Sonnet 3.7 (已弃用)	`text_editor_20250124`

Claude 4 模型的 text_editor_20250728 工具不包括 undo_edit 命令。如果您需要此功能，您需要使用 Claude Sonnet 3.7 (已弃用)。

较旧的工具版本不保证与较新的模型向后兼容。始终使用与您的模型版本相对应的工具版本。

何时使用文本编辑器工具

以下是何时使用文本编辑器工具的一些示例：

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

使用文本编辑器工具

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

1
向 Claude 提供文本编辑器工具和用户提示
- 在您的 API 请求中包含文本编辑器工具
- 提供可能需要检查或修改文件的用户提示，例如"您能修复我代码中的语法错误吗？"
2
Claude 使用工具检查文件或目录
- Claude 评估需要查看的内容，并使用 view 命令检查文件内容或列出目录内容
- API 响应将包含带有 view 命令的 tool_use 内容块
3
执行 view 命令并返回结果
- 从 Claude 的工具使用请求中提取文件或目录路径
- 读取文件的内容或列出目录内容
- 如果在工具配置中指定了 max_characters 参数，请将文件内容截断到该长度
- 通过继续对话并返回包含 tool_result 内容块的新 user 消息将结果返回给 Claude
4
Claude 使用工具修改文件
- 检查文件或目录后，Claude 可能会使用 str_replace 等命令进行更改或使用 insert 在特定行号处添加文本。
- 如果 Claude 使用 str_replace 命令，Claude 会构造一个格式正确的工具使用请求，其中包含旧文本和新文本以替换它
5
执行编辑并返回结果
- 从 Claude 的工具使用请求中提取文件路径、旧文本和新文本
- 在文件中执行文本替换
- 将结果返回给 Claude
6
Claude 提供其分析和解释
- 检查并可能编辑文件后，Claude 提供其发现内容和所做更改的完整解释

文本编辑器工具命令

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

view

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

参数：

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

str_replace

str_replace 命令允许 Claude 用新字符串替换文件中的特定字符串。这用于进行精确编辑。

参数：

command：必须为 "str_replace"
path：要修改的文件的路径
old_str：要替换的文本（必须完全匹配，包括空格和缩进）
new_str：要插入以替换旧文本的新文本

create

create 命令允许 Claude 创建具有指定内容的新文件。

参数：

command：必须为 "create"
path：应创建新文件的路径
file_text：要写入新文件的内容

insert

insert 命令允许 Claude 在文件中的特定位置插入文本。

参数：

command：必须为 "insert"
path：要修改的文件的路径
insert_line：要在其后插入文本的行号（0 表示文件开头）
new_str：要插入的文本

undo_edit

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

此命令仅在 Claude Sonnet 3.7 (已弃用) 中可用。Claude 4 模型使用 text_editor_20250728 不支持此命令。

参数：

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

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

实现文本编辑器工具

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

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

Claude 4：type: "text_editor_20250728"
Claude Sonnet 3.7：type: "text_editor_20250124"

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

处理编辑器工具调用

创建一个函数来处理来自 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": "undo_edit command is not supported in Claude 4"}
        # 为 Claude 3.7 从备份恢复
        pass

3
实现安全措施
添加验证和安全检查：
- 验证文件路径以防止目录遍历
- 在进行更改前创建备份
- 优雅地处理错误
- 实现权限检查

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

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

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

处理错误

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

遵循实现最佳实践

定价和令牌使用

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.x)	700 tokens
`text_editor_20250124` (Claude Sonnet 3.7 (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 命令。

模型兼容性

何时使用文本编辑器工具

使用文本编辑器工具

文本编辑器工具命令

view

查看命令示例

str_replace

str_replace 命令示例

create

create 命令示例

insert

insert 命令示例

undo_edit

undo_edit 命令示例

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

实现文本编辑器工具

处理错误

文件未找到

替换的多个匹配

替换无匹配

权限错误

遵循实现最佳实践

提供清晰的上下文

明确指定文件路径

在编辑前创建备份

谨慎处理唯一文本替换

验证更改

定价和令牌使用

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

更改日志

后续步骤

工具使用概述

令牌高效的工具使用

Bash 工具

模型兼容性

何时使用文本编辑器工具

使用文本编辑器工具

文本编辑器工具命令

view

查看命令示例

str_replace

str_replace 命令示例

create

create 命令示例

insert

insert 命令示例

undo_edit

undo_edit 命令示例

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

实现文本编辑器工具

处理错误

文件未找到

替换的多个匹配

替换无匹配

权限错误

遵循实现最佳实践

提供清晰的上下文

明确指定文件路径

在编辑前创建备份

谨慎处理唯一文本替换

验证更改

定价和令牌使用

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

更改日志

后续步骤

工具使用概述

令牌高效的工具使用

Bash 工具