Skip to content

Commit 94033bd

Browse files
committed
Add built-in tools
1 parent 8ee66f3 commit 94033bd

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

docs/copilot/copilot-edits.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Use Copilot Edits to start an AI-powered code editing session and iterate quickl
1515
Copilot Edits can function in two modes:
1616

1717
* [*Edit mode*](#use-edit-mode): select which files to edit, provide the relevant context and prompt, and Copilot will suggest code edits.
18-
* [*Agent mode*](#use-agent-mode-preview) (preview): let Copilot determine which files to edit and which commands to run. Copilot will autonomously use different tools to iterate and resolve issues to achieve the desired outcome.
18+
* [*Agent mode*](#use-agent-mode-preview) (preview): let Copilot determine which files to edit and which commands to run. Copilot will autonomously use different [tools](#agent-mode-tools) to iterate and resolve issues to achieve the desired outcome.
1919

2020
> [!TIP]
2121
> If you don't yet have a Copilot subscription, you can use Copilot for free by signing up for the [Copilot Free plan](https://github.com/github-copilot/signup) and get a monthly limit of completions and chat interactions.
@@ -79,7 +79,7 @@ In agent mode, Copilot Edits operates in a more autonomous and dynamic manner to
7979
* Offers both code changes and terminal commands to complete the task. For example, Copilot might compile code, install packages, run tests, and more.
8080
* Monitors correctness of code edits and terminal command output and iterates to remediate issues.
8181

82-
Copilot Edits agent mode uses a set of _tools_ to accomplish these tasks. For example, to determine which files to edit, gather project context, run terminal commands, read terminal output, and more.
82+
Copilot Edits agent mode uses a set of [_tools_](#agent-mode-tools) to accomplish these tasks. For example, to determine which files to edit, gather project context, run terminal commands, read terminal output, and more.
8383

8484
To enable agent mode in Copilot Edits, set the `setting(github.copilot.chat.agent.enabled)` setting to `true`.
8585

@@ -193,6 +193,21 @@ In the Chat view, select the **Edit with Copilot** button at the bottom of the c
193193

194194
After moving a chat request to Copilot Edits, the chat request is removed from the chat conversation in the Chat view.
195195

196+
## Agent mode tools
197+
198+
To complete a request, Copilot Edits uses a set of _tools_ to accomplish the individual tasks. The following list gives an overview of the built-in tools:
199+
200+
* search_codebase - Search the workspace for relevant code or documentation
201+
* file_search - Search for files by glob patterns (e.g., "**/*.js")
202+
* grep_search - Do a text search in files for exact strings or regex patterns
203+
* read_file - Read the contents of a file
204+
* edit_file - Edit a file in the workspace
205+
* list_dir - List the contents of a directory
206+
* run_in_terminal - Run shell commands in a terminal
207+
* get_terminal_output - Get output from a previously run terminal command
208+
* get_errors - Check for errors in code files
209+
* get_changed_files - Get diffs of file changes
210+
196211
## Settings
197212

198213
The following list contains the settings related to Copilot Edits. You can configure settings through the Setting editor (`kb(workbench.action.openSettings)`).

0 commit comments

Comments
 (0)