Skip to content

Commit 841cc99

Browse files
committed
Update
1 parent f13a092 commit 841cc99

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

docs/fundamentals/dashboard/mcp-server.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,13 @@ To get started, configure your local AI assistant to use Aspire MCP.
2222

2323
1. Run your Aspire app.
2424
2. Open the Aspire dashboard and click on the MCP button in the top right corner of the dashboard. This launches a dialog that contains instructions for using Aspire MCP.
25-
3. Use the specified details to configure your local AI assistant.
25+
3. Use the specified details in the dialog to configure your local AI assistant.
2626

27-
- `url` - The MCP address.
28-
- `x-mcp-api-key` - A HTTP header with a key to secure access to the MCP server.
27+
Important settings required to use Aspire MCP:
28+
29+
- `url` - Aspire MCP address.
30+
- `type` - `http` to indicate Aspire MCP is a [streamable-HTTP MCP server](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http).
31+
- `x-mcp-api-key` - An HTTP header with a key to secure access to the MCP server.
2932

3033
:::image type="content" source="media/mcp-server/mcp-dialog.png" lightbox="media/mcp-server/mcp-dialog.png" alt-text="A screenshot of the Aspire MCP dialog in the dashboard with the url and API header highlighted.":::
3134

@@ -61,7 +64,18 @@ The Aspire MCP server provides the following tools:
6164

6265
By default all resources, console logs and telemetry is accessible by Aspire MCP. Resources and associated telemetry can be excluded from MCP results by annotating the resource in the app host with `ExcludeFromMcp()`.
6366

64-
:::code language="csharp" source="snippets/Mcp/AppHost.cs" highlight="4":::
67+
```csharp
68+
var builder = DistributedApplication.CreateBuilder(args);
69+
70+
var apiservice = builder.AddProject<Projects.AspireApp_ApiService>("apiservice")
71+
.ExcludeFromMcp();
72+
73+
builder.AddProject<Projects.AspireApp_Web>("webfrontend")
74+
.WithExternalHttpEndpoints()
75+
.WithReference(apiService);
76+
77+
builder.Build().Run();
78+
```
6579

6680
## Troubleshooting
6781

docs/fundamentals/dashboard/snippets/Mcp/AppHost.cs

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)