-
Notifications
You must be signed in to change notification settings - Fork 168
Add Aspire MCP docs #5446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add Aspire MCP docs #5446
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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() |
758fc60 to
c6e1e5c
Compare
|
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. |
How do you configure it there? I'll add that to aspire.dev? See https://github.com/microsoft/aspire.dev/pull/8 |
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. |
Just the popular ones. |
|
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. |
|
you’re right |
Summary
Add Aspire MCP documentation. For Aspire 13.
Internal previews