Add Aspire MCP docs #5446
Merged
Add Aspire MCP docs #5446
+126
−0
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the new Aspire MCP (Model Context Protocol) server feature, which enables AI assistants to interact with Aspire resources and telemetry data during development.
Key Changes
- Documentation of MCP server functionality, including configuration, tools, and troubleshooting
- Code snippets demonstrating MCP configuration and usage
- Integration into the documentation table of contents
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/toc.yml | Adds "Aspire MCP" entry to the dashboard section of the documentation navigation |
| docs/fundamentals/dashboard/mcp-server.md | Main documentation file explaining MCP server setup, tools, prompts, and troubleshooting |
| docs/fundamentals/dashboard/snippets/Mcp/launchSettings.json | Example launch settings showing HTTP-only MCP endpoint configuration |
| docs/fundamentals/dashboard/snippets/Mcp/AppHost.cs | Example showing how to exclude a resource from MCP using ExcludeFromMcp() |
JamesNK
force-pushed
the
jamesnk/mcp-docs
branch
from
758fc60 to
c6e1e5c
Compare
Member
|
One addition, can be a follow up is how to configure this in the copilot CLI and claude code. It took me a while to figure it out. |
Member
How do you configure it there? I'll add that to aspire.dev? See microsoft/aspire.dev#8 |
Member
Author
There are links to copilot CLI and claude code MCP docs in the doc already. I don't think it's feasible to add detailed documentation for every product and keep it up to date. |
Member
Just the popular ones. |
Member
Author
|
Which are popular? Which do we want details for? VS? VS Code? Claude Code? Copilot CLI? I think building instructions into the dashboard dialog, like we already do for VS and VS Code, would be best. We can give an exact command line to run in the dashboard. In docs we'd need to have placeholders for the URL and HTTP header token. |
Member
|
you’re right |
JamesNK
force-pushed
the
jamesnk/mcp-docs
branch
from
c6e1e5c to
bc62b54
Compare
IEvangelist
added a commit
that referenced
this pull request
Nov 11, 2025
* Document ClaimActions configuration for dashboard OpenID Connect authentication (#5192) * Initial plan * Document ClaimActions configuration for dashboard OIDC authentication Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> * Apply suggestion from @JamesNK * Apply suggestion from @JamesNK * Apply suggestion from @JamesNK * Update configuration.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> Co-authored-by: James Newton-King <james@newtonking.com> * Document breaking change: DefaultAzureCredential defaults to ManagedIdentityCredential on ACA and App Service (#5303) * Initial plan * Add breaking change documentation for DefaultAzureCredential in 13.0 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix markdown linting error - add blank line before list Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update docs/compatibility/13.0/defaultazurecredential-managedidentity-default.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Update Azure AI Foundry and GitHub Models documentation to use strongly-typed model constants (#5302) * Initial plan * Update documentation to use AIFoundryModel and GitHubModel constants Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update compatibility matrix to use GitHubModel constant Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Update environment variable format to polyglot-friendly pattern (#5320) * Initial plan * Update environment variable format to polyglot-friendly pattern Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update AppHost project documentation for Aspire 13.0 SDK format (#5319) * Initial plan * Update AppHost project section to show new SDK format for Aspire 13.0 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md (#5318) * Initial plan * Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Apply suggestions from code review * Update docs/fundamentals/app-host-overview.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Add breaking changes documentation for pipeline activity reporter API rename (PR #12137) (#5310) * Initial plan * Add breaking changes article for PR #12137 and update documentation Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix parameter naming consistency in breaking change examples Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix cross reference warnings by using inline code formatting Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Add documentation for ASPIREPIPELINES001, ASPIREPIPELINES002, and ASPIREPIPELINES003 diagnostics (#5359) * Initial plan * Add documentation for three new pipeline-related diagnostics Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Fix ms.date to reflect current date in diagnostic documentation Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Update diagnostic codes to use ASPIREPIPELINES001-003 instead of mixed naming scheme Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Add ASPIREPIPELINES001-003 diagnostics to TOC Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add Aspire MCP docs (#5446) * Update configuration * Document deployment state caching (#5301) * Initial plan * Add local deployment state documentation Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address feedback: Add intros, italicize paths, add CI/CD example Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Rename and relocate deployment state doc outside Azure section Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Clarify cache save behavior in GitHub Actions example Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add certificate trust customization article for Aspire 13 (#5311) * Initial plan * Add certificate trust customization article Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix cross-reference title to match actual article title Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address PR feedback: update API examples, add runtime callout, document default scopes Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update callback APIs to use async Task and simplified context objects Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Replace deprecated callback APIs with new simplified APIs Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update documentation for new polyglot environment variables (issue #5308) (#5313) * Initial plan * Update documentation with new polyglot environment variable format Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add clarification about resource names in environment variables Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Improve clarity of note about connection name parameter Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update docs/fundamentals/app-host-overview.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Update documentation for Aspire 13 release * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: build --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> Co-authored-by: James Newton-King <james@newtonking.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
Add Aspire MCP documentation. For Aspire 13.
Internal previews