Skip to content

Commit f844ffc

Browse files
docs: update steps and improve instructions for clarity and consistency (#5)
* docs: update steps and improve instructions for clarity and consistency * docs: indent step3 * docs: remove overexplanation step3 * Add screenshot to step2
1 parent fd29bf8 commit f844ffc

File tree

6 files changed

+51
-49
lines changed

6 files changed

+51
-49
lines changed

.github/steps/1-step.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -51,39 +51,41 @@ We are using the same web application as in the [Getting Started with Copilot](h
5151

5252
1. Inside your codespace, create a new file named `mcp.json` in the `.vscode` directory and paste the following contents:
5353

54-
```json
55-
// .vscode/mcp.json
56-
{
57-
"servers": {
58-
"github": {
59-
"command": "npx",
60-
"args": ["-y", "@modelcontextprotocol/server-github"],
61-
"env": {
62-
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:githubToken}"
54+
```json
55+
// .vscode/mcp.json
56+
{
57+
"servers": {
58+
"github": {
59+
"command": "npx",
60+
"args": ["-y", "@modelcontextprotocol/server-github"],
61+
"env": {
62+
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:githubToken}"
63+
}
6364
}
64-
}
65-
},
66-
"inputs": [
67-
{
68-
"type": "promptString",
69-
"id": "githubToken",
70-
"description": "Enter your GitHub personal access token",
71-
"password": true
72-
}
73-
]
74-
}
75-
```
76-
77-
1. Save the file and you should see `Start` button show up like so:
78-
79-
![image](https://github.com/user-attachments/assets/c82a4202-1f4a-4123-ad14-5e33ecd6316c)
65+
},
66+
"inputs": [
67+
{
68+
"type": "promptString",
69+
"id": "githubToken",
70+
"description": "Enter your GitHub personal access token",
71+
"password": true
72+
}
73+
]
74+
}
75+
```
8076

81-
1. When you start the server, you will be prompted to provide a GitHub Token. You can use the token provided to you by the GitHub Codespace you are working in.
77+
1. In a moment, when you start the server - you will be prompted to provide a GitHub Token. Print it out in the terminal and copy it to your clipboard (`CTRL+C`).
8278

8379
```bash
8480
echo $GITHUB_TOKEN
8581
```
8682

83+
1. Back in the `.vscode/mcp.json` file you should see `Start` button show up like so:
84+
85+
![image](https://github.com/user-attachments/assets/c82a4202-1f4a-4123-ad14-5e33ecd6316c)
86+
87+
1. Click the `Start` button to launch the GitHub MCP server locally. When prompted, paste the GitHub token you copied earlier.
88+
8789
1. Validate the server is running.
8890

8991
1. The `.vscode/mcp.json` file should show if the server you started is running

.github/steps/2-step.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ Let's use GitHub Copilot Agent Mode together with GitHub MCP server to work on t
3333
> Are there any open bug report issues on my repository ({{{full_repo_name}}}) ?
3434
> ```
3535
36+
<details>
37+
<summary>:camera_flash: Copilot should figure out that it can use GitHub MCP server for this. </summary><br/>
38+
39+
<img width="400px" src="https://github.com/user-attachments/assets/7a9aea70-7c50-46d8-848e-092ade825573" />
40+
41+
</details>
42+
43+
44+
45+
46+
3647
> 🪧 **Note:** We explicitly include the repository name to add it to Copilot's session context. For subsequent prompts, this context will be preserved in the conversation.
3748
3849
> ✨ **Bonus:** You are welcome to try the prompt without it and if Copilot chooses to list issues in a different repository, guide it your way.
@@ -44,7 +55,7 @@ Let's use GitHub Copilot Agent Mode together with GitHub MCP server to work on t
4455
> ```prompt
4556
> Okay, let's start working on the bug report.
4657
> Comment on the issue that I will take a look at the issue and try to fix it.
47-
> Create a new branch, introduce the changes and raise a pull request to the `main` branch
58+
> Introduce the changes to the activities, push the changes to a new branch, and raise a pull request to `main`.
4859
> ```
4960
5061
> ⚠️ **Warning:** Always verify the information that Copilot passes to the MCP server before accepting.

.github/steps/3-step.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,8 @@ While AI assistants like GitHub Copilot can dramatically improve productivity, i
1111

1212
1. Examine the [pull request]({{{pull_request_url}}}) Copilot helped you create.
1313

14-
> **Bonus:** If your access is sufficient, you can ask Copilot to review your code.
14+
> **Bonus:** If your access is sufficient, you can ask Copilot to review your code.
1515
1616
1. Once you're satisfied with the changes, merge the pull request
1717

18-
> 🪧 **Note:** If you are not satisfied, go back to the codespace and work with Copilot to introduce the changes. Remember, coding is an iterative process.
19-
20-
<details>
21-
<summary>Having trouble?</summary><br/>
22-
23-
If you encounter issues:
24-
25-
- Make sure the PR was created correctly in the previous step
26-
- If needed, you can navigate directly to your repository on GitHub.com to find the PR
27-
- Remember that while MCP helps Copilot understand your repo better, human review is still essential
28-
29-
</details>
18+
> 🪧 **Note:** If you are not satisfied, go back to the codespace and work with Copilot to introduce the changes. Remember, coding is an iterative process.

.github/steps/4-step.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
## Step 4: Wrap up on the bug report
22

3-
43
### :keyboard: Activity: Wrap up the bug report
54

65
1. Open the **Copilot Chat Agent Mode** session in VS Code.
@@ -21,4 +20,3 @@
2120
- Check what information is passed to the MCP server calls - is Copilot using the correct repository?
2221
- Did Copilot comment on the bug report?
2322
</details>
24-

.github/steps/x-review.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
## Review
22

3-
_Congratulations, you've completed this Exercise and joined the world of developers!_
3+
_Congratulations, you've completed this Exercise and learned the basics of MCP !_
44

55
<img src=https://octodex.github.com/images/collabocats.jpg alt=celebrate width=300 align=right>
66

7-
Here's a recap of your accomplishments:
8-
9-
107
### What's next?
118

129

1310
Check out these resources to learn more or get involved:
1411

1512
- [Take another GitHub Skills exercise](https://skills.github.com).
16-
_
17-
18-
__
13+
- Learn more about [Model Context Protocol](https://modelcontextprotocol.io/introduction)
14+
- Try other MCP servers! GitHub is just one of [many](https://github.com/modelcontextprotocol/servers)

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,9 @@
3535
.Trashes
3636
ehthumbs.db
3737
Thumbs.db
38+
39+
# Python files
40+
__pycache__
41+
42+
# Env files
43+
.env

0 commit comments

Comments
 (0)