Skip to content

Conversation

@JamesNK
Copy link
Member

@JamesNK JamesNK commented Nov 3, 2025

Summary

Add Aspire MCP documentation. For Aspire 13.


Internal previews

📄 File 🔗 Preview link
docs/fundamentals/dashboard/mcp-server.md docs/fundamentals/dashboard/mcp-server
docs/toc.yml docs/toc

@JamesNK JamesNK requested a review from IEvangelist as a code owner November 3, 2025 09:59
Copilot AI review requested due to automatic review settings November 3, 2025 09:59
Copy link
Contributor

Copilot AI left a 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()

@davidfowl
Copy link
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.

@IEvangelist
Copy link
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.

How do you configure it there? I'll add that to aspire.dev? See https://github.com/microsoft/aspire.dev/pull/8

@JamesNK
Copy link
Member Author

JamesNK commented Nov 4, 2025

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.

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.

@davidfowl
Copy link
Member

I don't think it's feasible to add detailed documentation for every product and keep it up to date.

Just the popular ones.

@JamesNK
Copy link
Member Author

JamesNK commented Nov 4, 2025

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.

@davidfowl
Copy link
Member

you’re right

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants