Skip to content

Commit 5d6442c

Browse files
Improve responsible Copilot CLI readability (#59782)
Co-authored-by: hubwriter <hubwriter@github.com>
1 parent 11e4bd9 commit 5d6442c

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

content/copilot/concepts/agents/coding-agent/about-custom-agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The {% data variables.copilot.agent_profile %} defines the {% data variables.cop
2727
* **Prompt**: Custom instructions that define the agent's behavior and expertise.
2828
* **Tools** (optional): Specific tools the agent can access. By default, agents can access all available tools, including built-in tools and MCP server tools.
2929

30-
{% data variables.copilot.agent_profiles_caps %} can also include MCP server configurations using the `mcp-server` property.
30+
{% data variables.copilot.agent_profiles_caps %} can also include MCP server configurations using the `mcp-server` property.
3131

3232
### Example {% data variables.copilot.agent_profile %}
3333

content/copilot/responsible-use/copilot-cli.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ redirect_from:
1414
- /copilot/responsible-use-of-github-copilot-features/copilot-in-the-cli
1515
- /copilot/responsible-use/copilot-in-the-cli
1616
contentType: rai
17-
category:
17+
category:
1818
- Responsible use
1919
- Learn about Copilot CLI
2020
---
@@ -35,11 +35,11 @@ The agent works by using a combination of natural language processing and machin
3535

3636
### Input processing
3737

38-
The input prompt from the user is combined with other relevant, contextual information to form a prompt. That prompt is sent to a large language model for processing. Inputs can take the form of plain natural language, code snippets, or references to files in your terminal.
38+
Your input is combined with relevant contextual information to form a prompt. That prompt is sent to a large language model for processing. Inputs can take the form of plain natural language, code snippets, or references to files in your terminal.
3939

4040
### Language model analysis
4141

42-
The prompt is then passed through a large language model, which is a neural network that has been trained on a large body of data. The language model analyzes the input prompt to help the agent reason on the task and leverage necessary tools.
42+
The prompt is then passed through a large language model, which is a neural network that has been trained on a large body of data. The language model analyzes the input prompt to help the agent reason about the task and use the necessary tools.
4343

4444
### Response generation
4545

@@ -76,15 +76,15 @@ For more information about limitations, see the section [Limitations of {% data
7676

7777
### Ensure your tasks are well-scoped
7878

79-
{% data variables.copilot.copilot_cli %} leverages your prompt as key context when generating a pull request. The more clear and well-scoped the prompt you assign to the agent, the better the results you will get. An ideal issue includes:
79+
{% data variables.copilot.copilot_cli %} leverages your prompt as key context when completing a task. The clearer and more well-scoped the prompt you provide, the better the results you will get. An ideal prompt includes:
8080

8181
* A clear description of the problem to be solved or the work required.
8282
* Complete acceptance criteria on what a good solution looks like (for example, should there be unit tests?).
8383
* Hints or pointers on what files need to be changed.
8484

8585
### Customize your experience with additional context
8686

87-
{% data variables.copilot.copilot_cli %} leverages your prompt, comments and the repository’s code as context when generating suggested changes. To enhance {% data variables.product.prodname_copilot_short %}’s performance, consider implementing custom {% data variables.product.prodname_copilot_short %} instructions to help the agent better understand your project and how to build, test and validate its changes. For more information, see "Add custom instructions to your repository" in [AUTOTITLE](/copilot/tutorials/coding-agent/get-the-best-results#adding-custom-instructions-to-your-repository).
87+
{% data variables.copilot.copilot_cli %} leverages your prompt and the repository’s code as context when generating suggested changes. To enhance {% data variables.product.prodname_copilot_short %}’s performance, consider implementing custom {% data variables.product.prodname_copilot_short %} instructions to help the agent better understand your project and how to build, test and validate its changes. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions).
8888

8989
### Use {% data variables.copilot.copilot_cli %} as a tool, not a replacement
9090

@@ -102,11 +102,13 @@ If you encounter any issues or limitations with {% data variables.copilot.copilo
102102

103103
### Constraining {% data variables.product.prodname_copilot_short %}’s permissions
104104

105-
By default, {% data variables.product.prodname_copilot_short %} only has access to files and folders in, and below, the directory from which {% data variables.copilot.copilot_cli %} was invoked. Ensure you trust the files in this directory. If {% data variables.product.prodname_copilot_short %} wishes to access files outside the current directory, it will ask for permission. Only grant it permission if you trust the contents of that directory.
105+
By default, {% data variables.copilot.copilot_cli_short %}:
106106

107-
{% data variables.product.prodname_copilot_short %} will ask for permission before modifying files. Ensure that it is modifying the correct files before granting permission.
107+
* Only has access to files and folders in, and below, the directory from which {% data variables.copilot.copilot_cli %} was invoked. Ensure you trust the files in this directory. If {% data variables.product.prodname_copilot_short %} wishes to access files outside the current directory, it will ask for permission. Only grant it permission if you trust the contents of that directory.
108+
* Will ask for permission before modifying files. Ensure that it is modifying the correct files before granting permission.
109+
* Will ask for permission before executing commands that may be dangerous. Review these commands carefully before giving it permission to run.
108110

109-
{% data variables.product.prodname_copilot_short %} will also ask for permission before executing commands that may be dangerous. Review these commands carefully before giving it permission to run.
111+
You can grant {% data variables.copilot.copilot_cli_short %} specific permissions, or all permissions, by using the various command line options: for example, `--allow-tool [TOOLS...]`, `--allow-all-tools`, `--allow-all` (or its slash command equivalent `/allow-all` for use in an interactive session). For more information, see [AUTOTITLE](/copilot/reference/cli-command-reference#command-line-options). Typically, when you use {% data variables.copilot.copilot_cli_short %} in autopilot mode, you will grant it full permissions to allow it to complete a task autonomously, without requiring you to approve activity as it works on the task. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot).
110112

111113
For more information about security practices while using {% data variables.copilot.copilot_cli %}, see "Security considerations" in [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli#security-considerations).
112114

0 commit comments

Comments
 (0)