Add onboarding doc for Azure MCP Server#2918
Open
RickWinter wants to merge 3 commits into
Open
Conversation
Adds docs/Onboarding.md covering prerequisites, adding a new namespace, adding a new tool, and integrating an external MCP server. Adds a .github/agents/onboarding.agent.md Copilot agent that routes contributors to the guide, links it from CONTRIBUTING.md, and fixes a few pre-existing typos surfaced by cspell. Fixes microsoft#2512 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
RickWinter
requested review from
KarishmaGhiya,
alzimmermsft,
chidozieononiwu,
conniey,
tmeschter,
vukelich and
wbreza
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor onboarding guidance for the Azure MCP Server by introducing a new onboarding doc and a companion Copilot agent, plus minor CONTRIBUTING and spelling-dictionary updates to improve discoverability and reduce cspell noise.
Changes:
- Add
docs/Onboarding.mdcovering prerequisites, quick start, adding namespaces/tools, and external MCP server integration. - Add
.github/agents/onboarding.agent.mdto route contributors to the appropriate onboarding sections and deeper docs. - Update
CONTRIBUTING.mdto link to the onboarding guide and fix a few typos; extend.vscode/cspell.jsonallowlist for repo-specific tokens.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/Onboarding.md | New onboarding “source of truth” doc for Azure MCP Server contributor workflows |
| .github/agents/onboarding.agent.md | New @onboarding agent to route users to onboarding sections and authoritative docs |
| CONTRIBUTING.md | Adds onboarding discoverability tip + fixes pre-existing typos |
| .vscode/cspell.json | Adds allowlisted terms used in docs and repo conventions |
JasonYeMSFT
reviewed
Jun 19, 2026
JasonYeMSFT
reviewed
Jun 19, 2026
- Convert relative file links to full https://github.com/microsoft/mcp/blob/main/ URLs per repo convention (so docs sites resolve them). - Make the onboarding agent reference and Azure.Mcp.Server.slnx clickable links. - Remove implementation-conventions section from the onboarding agent (belongs in AGENTS.md/review agent). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JasonYeMSFT
previously approved these changes
Jun 22, 2026
github-project-automation
Bot
moved this from Untriaged
to In Progress
in Azure MCP Server
JasonYeMSFT
dismissed
their stale review
Found another PR adding the same agent file that needs to be resolved.
Removes .github/agents/onboarding.agent.md and the references to it in docs/Onboarding.md and CONTRIBUTING.md so this PR only adds the onboarding documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
RickWinter
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves #2512 by adding agentic onboarding instructions for the Azure MCP Server.
Adds a human-readable onboarding guide covering the four areas requested in the issue:
tools/Azure.Mcp.Tools.{Toolset}, implementingIAreaSetup, registering alphabetically inProgram.csRegisterAreas(), solution-file and AOT steps.servers/Azure.Mcp.Server/src/Resources/registry.json, HTTP/SSE vs stdio transport, and authentication considerations.Changes
docs/Onboarding.md— the onboarding guide (source of truth), linking to the authoritative deep-dive docs (new-command.md,CONTRIBUTING.md,recorded-tests.md, etc.) via full GitHub URLs.CONTRIBUTING.md— adds a discoverability callout linking to the onboarding guide, and fixes a few pre-existing typos surfaced by cspell..vscode/cspell.json— allowlists legitimate tokens (slnx,uniqueprefix,configfile,remotemcp).Validation
./eng/common/spelling/Invoke-Cspell.ps1on the changed files — 0 issues.Invoking Livetests
Copilot submitted PRs are not trustworthy by default. Users with
writeaccess to the repo need to validate the contents of this PR before leaving a comment with the text/azp run mcp - pullrequest - live. This will trigger the necessary livetest workflows to complete required validation.