apply_patch tool

Apply file changes using a structured patch format. This is ideal for multi-file or multi-hunk edits where a single

call would be brittle.

The tool accepts a single

string that wraps one or more file operations:

text
Copy
*** 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

Parameters

• text

  Copy

  input
  (required): Full patch contents including
  text

  Copy

  *** Begin Patch
  and
  text

  Copy

  *** End Patch
  .

Notes

• Patch paths support relative paths (from the workspace directory) and absolute paths.
• text

  Copy

  tools.exec.applyPatch.workspaceOnly
  defaults to
  text

  Copy

  true
  (workspace-contained). Set it to
  text

  Copy

  false
  only if you intentionally want
  text

  Copy

  apply_patch
  to write/delete outside the workspace directory.
• Use
  text

  Copy

  *** Move to:
  within an
  text

  Copy

  *** Update File:
  hunk to rename files.
• text

  Copy

  *** End of File
  marks an EOF-only insert when needed.
• Available by default for OpenAI and OpenAI Codex models. Set
  text

  Copy

  tools.exec.applyPatch.enabled: false
  to disable it.
• Optionally gate by model via
  text

  Copy

  tools.exec.applyPatch.allowModels
  .
• Config is only under
  text

  Copy

  tools.exec
  .

Example

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

Related

• Diffs
• Exec tool
• Code execution