Skip to content

Commit 2a58e93

Browse files
Hannia Valerahanniavalera
authored andcommitted
feat: enhance onboarding documentation with MCP server usage instructions and examples
1 parent 1c02853 commit 2a58e93

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
This article is for developers who want to contribute to the CMake Tools open source project.
44

5+
## New here? Try the onboarding assistant
6+
7+
This repo includes an MCP server that gives GitHub Copilot structured knowledge about the codebase. It can walk you through setup, explain concepts like kits and presets, point you to the right source files, and help you find issues to work on.
8+
9+
To set it up, build it once:
10+
11+
```bash
12+
cd tools/onboarding-mcp
13+
npm install
14+
npm run build
15+
```
16+
17+
Then open **Copilot Chat** in VS Code (`Ctrl+Shift+I`), switch to **Agent mode**, and ask anything — for example *"How do I set up this repo?"* or *"What's a good first issue?"*
18+
19+
See [`tools/onboarding-mcp/README.md`](tools/onboarding-mcp/README.md) for full details and example prompts.
20+
521
## Build the CMake Tools extension
622

723
As with most VS Code extensions, you'll need [Node.JS](https://nodejs.org/en/) installed. We use yarn to compile the code (run `npm install -g yarn` to install it).

tools/onboarding-mcp/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,48 @@ The `GITHUB_TOKEN` env var is **optional** but recommended. Without it, GitHub A
3333

3434
Once configured, the MCP server is available to Copilot agent mode (and any other MCP client) in VS Code.
3535

36+
## Usage
37+
38+
The MCP server works **inside GitHub Copilot Chat** in VS Code. There's nothing extra to install — the `.vscode/mcp.json` in this repo already registers the server. Just build it and go:
39+
40+
```bash
41+
cd tools/onboarding-mcp
42+
npm install
43+
npm run build
44+
```
45+
46+
Then open a **Copilot Chat** panel (press `Ctrl+Shift+I` or click the Copilot icon in the sidebar) and switch to **Agent mode** (the dropdown at the top of the chat panel). VS Code may show a notification asking you to start the MCP server — click **Start**.
47+
48+
Once it's running, just ask questions in natural language. Copilot will automatically call the right tools. Here are some things you can try:
49+
50+
### Getting started
51+
- *"How do I set up this repo for local development?"*
52+
- *"Walk me through building and running the extension."*
53+
54+
### Understanding the codebase
55+
- *"What is a kit? How is it different from a preset?"*
56+
- *"Explain how the CMake driver works."*
57+
- *"Where is the code that handles CTest?"*
58+
- *"Which source file should I look at for build logic?"*
59+
60+
### Finding documentation
61+
- *"Show me the docs page about CMake Presets."*
62+
- *"Where can I find troubleshooting info?"*
63+
64+
### Exploring issues to work on
65+
- *"What are some good issues for a new contributor?"*
66+
- *"Show me recent open issues labeled 'enhancement'."*
67+
68+
### Understanding recent activity
69+
- *"What areas of the codebase have changed recently?"*
70+
- *"Show me the last 5 commits to main."*
71+
72+
### Preparing a PR
73+
- *"I changed the preset loading logic and added a new setting. Is my PR ready?"*
74+
- *"What do I need to check before submitting a PR?"*
75+
76+
> **Tip:** You don't need to name the tools or remember their inputs. Just describe what you need and Copilot will figure out which tool to call.
77+
3678
## Development
3779

3880
```bash

0 commit comments

Comments
 (0)