Skip to content

Commit 3463bc6

Browse files
committed
Fix typos and improve clarity in README.md files for GitHub Copilot CLI and Coding Agent modules
1 parent 8ae769b commit 3463bc6

File tree

2 files changed

+27
-68
lines changed

2 files changed

+27
-68
lines changed

Using-GitHub-Copilot-CLI/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ By the end of this module, you'll acquire the skills to be able to:
3838

3939
2. Install the standalone **GitHub Copilot CLI** (see Section 1 — the old `gh copilot` extension has been replaced by this new tool)
4040

41-
3. Fork then clone [this repository locally](https://github.com/MicrosoftDocs/mslearn-copilot-codespaces-python) for the following exercises.
41+
3. Fork and then clone [this repository locally](https://github.com/MicrosoftDocs/mslearn-copilot-codespaces-python) for the following exercises.
4242

4343
## 💪🏽 Exercise
4444

Using-GitHub-Copilot-Coding-Agent/README.md

Lines changed: 26 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,14 @@ By the end of this module, you'll acquire the skills to:
2323

2424
## 📖 Prerequisite reading
2525

26-
- [About GitHub Copilot coding agent](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-coding-agent)
26+
- [About GitHub Copilot coding agent](https://docs.github.com/copilot/concepts/agents/coding-agent/about-coding-agent)
2727
- [Introduction to prompt engineering with GitHub Copilot](https://learn.microsoft.com/training/modules/introduction-prompt-engineering-with-github-copilot/?WT.mc_id=academic-113596-abartolo)
28-
- [GitHub Copilot coding agent vs. agent mode](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-coding-agent#copilot-coding-agent-versus-agent-mode)
28+
- [GitHub Copilot coding agent vs. agent mode](https://docs.github.com/copilot/concepts/agents/coding-agent/about-coding-agent#copilot-coding-agent-versus-agent-mode)
2929

3030
## 📋 Requirements
3131

3232
1. Enable your [GitHub Copilot service](https://github.com/github-copilot/signup) (Pro, Pro+, Business, or Enterprise plan required for coding agent)
33-
2. Open [this repository with Codespaces](https://codespaces.new/github-samples/node-recipe-app?quickstart=1) — a Node.js recipe app with known missing features that serves as our working example throughout this module.
34-
35-
**Right click the following Codespaces button to open your Codespace in a new tab**
36-
37-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/github-samples/node-recipe-app?quickstart=1)
38-
39-
> **Note:** If you have an existing Codespace with this project, please create a new one for this module.
33+
2. Fork and then clone [this repository locally](https://github.com/github-samples/node-recipe-app?quickstart=1) for the following exercises. You can also run this lab in a GitHub Codespace from your forked repository.
4034

4135
---
4236

@@ -276,9 +270,9 @@ Custom instructions are Markdown files you store in your repository that tell Co
276270

277271
> **Tip:** You can also define custom instructions at the organization level from your organization's settings.
278272
279-
### Part 2: Custom Agents — Agent Profiles
273+
### Part 2: Custom Agents
280274

281-
**Custom agents** are specialized versions of Copilot you define once using a Markdown file called an **agent profile**. Each profile encodes a specific persona, set of tools, and behavior.
275+
**Custom agents** are specialized versions of Copilot you define once using a Markdown file. Each profile encodes a specific persona, set of tools, and behavior. Custom agent profiles can also be defined at the [organization level](https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents) in a `.github-private` repository, making them available across all repositories in your organization.
282276

283277
1. Create the file `.github/agents/documentation-agent.md`:
284278

@@ -322,11 +316,11 @@ Custom instructions are Markdown files you store in your repository that tell Co
322316

323317
3. Commit both files. When you assign a task from the agents panel or an issue, you can now select a specific custom agent to use.
324318

325-
> **Note:** Custom agent profiles can also be defined at the organization level in a `.github-private` repository, making them available across all repositories in your organization.
326-
327319
### Part 3: Model Context Protocol (MCP) Servers
328320

329-
**MCP servers** give Copilot coding agent access to external data sources and tools — such as a project management system, internal documentation, or a database — that it wouldn't be able to reach otherwise.
321+
**MCP servers** give Copilot coding agent access to external data sources and tools — such as a project management system, internal documentation, or a database — that it wouldn't be able to reach otherwise. For organization-level or enterprise-level custom agents, the agent definition is managed centrally (not just in a repo under `.github/agents/`).
322+
323+
In those centrally managed agent profiles, you can define MCP servers directly in the YAML frontmatter of the agent profile. This allows administrators to centrally define which external tools the agent can access, eliminating the need for developers to configure MCP servers locally. This gives the agent access to those tools, allowing them to be policy-controlled and centralizing governance.
330324

331325
1. Create the file `.github/mcp.json` in your repository:
332326

@@ -343,9 +337,7 @@ Custom instructions are Markdown files you store in your repository that tell Co
343337

344338
2. The default GitHub MCP server is pre-configured and gives the agent access to your repository's issues, historic pull requests, and code search — grounding its responses in real project context.
345339

346-
3. To add a third-party MCP server (for example, a Jira integration), follow the [MCP integration guide](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp) and add the server configuration to `.github/mcp.json`.
347-
348-
> **Note:** Organization and enterprise-level agent profiles can embed MCP server configuration directly within the agent profile YAML frontmatter.
340+
3. To add a third-party MCP server (for example: a Jira integration, an Azure DevOps integration, or other 3rd party service), follow the [MCP integration guide](https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp) and add the server configuration to `.github/mcp.json`.
349341

350342
### Part 4: Hooks — Lifecycle Automation
351343

@@ -411,11 +403,11 @@ Every session Copilot runs includes automatic security validation before the pul
411403

412404
Details of all security checks are visible in the session log.
413405

414-
> **Note:** These built-in checks do **not** require a GitHub Advanced Security, Secret Protection, or Code Security license.
406+
> **Note:** These built-in checks require a GitHub Advanced Security (GHAS license)
415407

416408
### Exercise 5A: Assign a Security Alert to Copilot via a Security Campaign
417409

418-
**Security campaigns** let you fix groups of security alerts at scale by assigning them to the coding agent.
410+
[Security campaigns](https://docs.github.com/enterprise-cloud@latest/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/creating-managing-security-campaigns) let you fix groups of security alerts at scale by assigning them to the coding agent.
419411

420412
1. Navigate to your repository's **Security** tab → **Code scanning alerts**.
421413
2. If there are open alerts, click **Campaigns** in the left nav (available for orgs with GitHub Advanced Security).
@@ -448,6 +440,8 @@ In the above exercises we achieved the following:
448440
- Use Raycast to start and monitor tasks without leaving your desktop.
449441
- Understand how the coding agent fits into the full SDLC — from backlog to merge.
450442

443+
> **Note:** You can also execute the coding agent into a full SDLC using Copilot Chat in VSCode
444+
451445
### Exercise 6A: Using the GitHub CLI
452446

453447
> Requires GitHub CLI v2.80.0 or later. Run `gh --version` to check.
@@ -471,7 +465,11 @@ gh agent-task view --repo YOUR-ORG/YOUR-REPO 45 --log --follow
471465
1. Install [Raycast](https://www.raycast.com/).
472466
2. Install the [GitHub Copilot extension for Raycast](https://www.raycast.com/github/github-copilot).
473467
3. Open Raycast and search for **Copilot → View Tasks** to see all your sessions.
474-
4. Press `Command+L` to view the session log for any task.
468+
4. To view the session log for any task, open the log using the following command:
469+
**Windows:**
470+
`Ctrl + L`
471+
**macOS:**
472+
`Command+L`
475473
5. Start a new session directly from Raycast without opening a browser.
476474

477475
### The Coding Agent in the Full SDLC
@@ -514,58 +512,19 @@ To change the model:
514512
2. Select your preferred model.
515513
3. The model selection applies to that session only.
516514

517-
For more details, see [Changing the AI model for GitHub Copilot coding agent](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model).
518-
519-
---
520-
521-
## ✅ Module Summary
522-
523-
Across this module, the key capabilities you exercised include:
524-
525-
```
526-
Assigning Tasks
527-
✅ Issue assignment via the Assignees dropdown
528-
✅ @copilot mentions in PR comments
529-
✅ New tasks from the agents panel
530-
✅ Tasks from VS Code, JetBrains, Eclipse, GitHub CLI, and Raycast
531-
532-
Tracking & Steering
533-
✅ Session logs and internal monologue
534-
✅ Live log streaming with the GitHub CLI
535-
✅ Steering an in-progress session
536-
✅ Stopping a session
537-
538-
Review & Iteration
539-
✅ Reviewing and commenting on Copilot PR output
540-
✅ Requesting Copilot as a code reviewer on your own PRs
541-
542-
Customization
543-
✅ Custom instructions (.github/copilot-instructions.md)
544-
✅ Custom agent profiles (.github/agents/*.md)
545-
✅ MCP server integration (.github/mcp.json)
546-
✅ Lifecycle hooks (.github/copilot/hooks.yaml)
547-
✅ Copilot Memory (Pro/Pro+)
548-
549-
Security & Compliance
550-
✅ Built-in CodeQL, secret scanning, and dependency checks
551-
✅ Security campaign bulk assignment
552-
✅ Governance model and audit trail
553-
554-
SDLC Integration
555-
✅ Every phase of delivery — planning through merge
556-
```
515+
For more details, see [Changing the AI model for GitHub Copilot coding agent](https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model).
557516

558517
---
559518

560519
## 📖 Further Reading
561520

562-
- [GitHub Copilot coding agent — all how-to articles](https://docs.github.com/en/copilot/how-tos/use-copilot-agents)
563-
- [About custom agents](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-custom-agents)
564-
- [Extending the coding agent with MCP](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp)
565-
- [About hooks](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-hooks)
566-
- [About agent skills](https://docs.github.com/en/copilot/concepts/agents/about-agent-skills)
567-
- [Responsible use of GitHub Copilot coding agent](https://docs.github.com/en/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom)
568-
- [Piloting Copilot coding agent in your organization](https://docs.github.com/en/copilot/tutorials/pilot-copilot-coding-agent)
521+
- [GitHub Copilot coding agent — all how-to articles](https://docs.github.com/copilot/how-tos/use-copilot-agents)
522+
- [About custom agents](https://docs.github.com/copilot/concepts/agents/coding-agent/about-custom-agents)
523+
- [Extending the coding agent with MCP](https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp)
524+
- [About hooks](https://docs.github.com/copilot/concepts/agents/coding-agent/about-hooks)
525+
- [About agent skills](https://docs.github.com/copilot/concepts/agents/about-agent-skills)
526+
- [Responsible use of GitHub Copilot coding agent](https://docs.github.com/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom)
527+
- [Piloting Copilot coding agent in your organization](https://docs.github.com/copilot/tutorials/pilot-copilot-coding-agent)
569528
- [GitHub Copilot Trust Center](https://copilot.github.trust.page/)
570529
- [GitHub Changelog — Copilot](https://github.blog/changelog/?label=copilot)
571530
- [Skills exercise: Expand your team with Copilot coding agent](https://github.com/skills/expand-your-team-with-copilot/)

0 commit comments

Comments
 (0)