跳轉到主要內容

apply_patch 工具

Apply file changes using a structured patch format. 這非常適合多檔案或多區塊(multi-hunk)的編輯,因為單一 edit 呼叫會很脆弱。 此工具接受單一的 input 字串,該字串包裝一或多個檔案操作:
*** Begin Patch
*** Add File: path/to/file.txt
+line 1
+line 2
*** Update File: src/app.ts
@@
-old line
+new line
*** Delete File: obsolete.txt
*** End Patch

參數

  • input(必填):包含 *** Begin Patch*** End Patch 的完整修補內容。

注意事項

  • Paths are resolved relative to the workspace root.
  • tools.exec.applyPatch.workspaceOnly 預設為 true(僅限 workspace 內)。 僅在你有意讓 apply_patch 在 workspace 目錄外寫入或刪除檔案時,才將其設為 false
  • *** Update File: 區塊(hunk)中使用 *** Move to: 以重新命名檔案。
  • 在需要時,*** End of File 會標示僅於 EOF 的插入。
    1. 屬於實驗性功能,且預設停用。 屬於實驗性功能,且預設停用。 屬於實驗性功能,預設為停用。請使用 tools.exec.applyPatch.enabled 啟用。
  • OpenAI-only (including OpenAI Codex). 可選擇依模型進行門控,透過 tools.exec.applyPatch.allowModels
  • 設定僅位於 tools.exec 之下。

範例

{
  "tool": "apply_patch",
  "input": "*** Begin Patch\n*** Update File: src/index.ts\n@@\n-const foo = 1\n+const foo = 2\n*** End Patch"
}