Skip to content

Commit 006b7c6

Browse files
author
Hannia Valera
committed
feat: update onboarding tools documentation to clarify contributor issue fetching and recent changes tools
1 parent 627ce7d commit 006b7c6

1 file changed

Lines changed: 2 additions & 16 deletions

File tree

tools/onboarding-mcp/README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,26 +90,12 @@ npm start
9090

9191
## Available tools
9292

93-
### Phase 1 — Setup & PR
94-
9593
| Tool | Input | Description |
9694
| --- | --- | --- |
9795
| **`get_setup_guide`** | _(none)_ | Returns an ordered list of setup steps for new contributors to build and run the extension locally. Each step includes a number, title, optional shell command, and optional notes. |
9896
| **`check_pr_readiness`** | `{ "changes": "..." }` | Given a free-text description of changes, returns a checklist of PR requirements from CONTRIBUTING.md. Each item includes the rule, a status (`"pass"`, `"warn"`, or `"manual_check_required"`), and a helpful hint. Items are flagged as `"warn"` when the description suggests a potential issue (e.g. mentioning `package.json` changes). |
99-
100-
### Phase 2 — Codebase Knowledge
101-
102-
| Tool | Input | Description |
103-
| --- | --- | --- |
10497
| **`explain_concept`** | `{ "concept": "..." }` | Explains a CMake Tools concept (e.g. `kit`, `preset`, `driver`, `ctest`, `build`, `configure`, `debug`, `settings`). Returns a summary, detailed explanation, related concepts, relevant source files, and a link to the docs page. If the concept is unknown, lists all known concepts. |
10598
| **`find_source_file`** | `{ "feature": "..." }` | Given a natural-language description (e.g. `"kit scanning"`, `"build logic"`, `"test runner"`), returns matching source files with GitHub links, descriptions, and relevance notes. Useful for quickly navigating to the right file. |
10699
| **`get_docs_page`** | `{ "topic": "..." }` | Given a topic (e.g. `presets`, `kits`, `debugging`, `troubleshooting`, `faq`), returns the matching documentation page with file path, GitHub URL, summary, and key section headings. |
107-
108-
### Phase 3 — Live GitHub Data
109-
110-
These tools make real GitHub API calls. They work without authentication (60 req/hr) but setting `GITHUB_TOKEN` raises the limit to 5,000 req/hr (see [Wire it up in VS Code](#wire-it-up-in-vs-code) above).
111-
112-
| Tool | Input | Description |
113-
| --- | --- | --- |
114-
| **`get_contributor_issues`** | `{ "limit?": 20, "label?": "..." }` | Fetches recently updated open issues and enriches each with contributor-friendliness signals (`hasGoodFirstIssueLabel`, `isRecentlyUpdated`, `hasLowCommentCount`, `hasNoBugLabel`). Optionally filter by label (e.g. `"bug"`, `"enhancement"`, `"good first issue"`, `"help wanted"`). Intentionally does **not** default to `"good first issue"` filtering because that label is sparsely used — Copilot should reason over the full issue list instead. |
115-
| **`get_recent_changes`** | `{ "limit?": 10 }` | Fetches the most recent commits to main and annotates each with `affectedAreas` (derived from commit message keywords matched against the codebase source map). Includes a summary of the most active areas so new contributors can see what's currently in flux. |
100+
| **`get_contributor_issues`** | `{ "limit?": 20, "label?": "..." }` | Fetches recently updated open issues and enriches each with contributor-friendliness signals. Optionally filter by label (e.g. `"bug"`, `"enhancement"`, `"good first issue"`, `"help wanted"`). Requires a network connection; set `GITHUB_TOKEN` for higher rate limits (see [above](#wire-it-up-in-vs-code)). |
101+
| **`get_recent_changes`** | `{ "limit?": 10 }` | Fetches the most recent commits to main and annotates each with `affectedAreas` derived from the codebase source map. Includes a summary of the most active areas so new contributors can see what's currently in flux. |

0 commit comments

Comments
 (0)