Add Bun support for MCP Inspector resource builder #1079
+95
−26
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
Introduces the WithBun extension method to allow configuring the MCP Inspector to use Bun (bunx) as the package manager. Updates argument handling logic, documentation, API surface, and adds corresponding unit tests to ensure correct command and argument setup for Bun.
Author
|
@dotnet-policy-service agree |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds support for Bun as a package manager option for the MCP Inspector resource, complementing the existing npm, yarn, and pnpm support. The change introduces a WithBun() extension method that configures the inspector to use bunx for running the MCP Inspector package.
Key Changes
- Adds
WithBun()extension method to configure Bun/bunx as the package manager - Updates argument handling logic to support bunx command pattern (no additional flags needed beyond package name)
- Extends documentation with Bun usage examples
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| src/CommunityToolkit.Aspire.Hosting.McpInspector/McpInspectorResourceBuilderExtensions.cs | Implements WithBun() method and adds bunx case to argument handling logic |
| src/CommunityToolkit.Aspire.Hosting.McpInspector/README.md | Updates documentation to include Bun in supported package managers with usage example |
| src/CommunityToolkit.Aspire.Hosting.McpInspector/api/CommunityToolkit.Aspire.Hosting.McpInspector.cs | Adds new public API surface for WithBun, WithYarn, and WithPnpm methods |
| tests/CommunityToolkit.Aspire.Hosting.McpInspector.Tests/McpInspectorResourceBuilderExtensionsTests.cs | Adds comprehensive tests for WithBun functionality and refactors existing assertions for consistency |
Comment on lines
+33
to
+40
| public static ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> WithBun(this ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> builder) { throw null; } | ||
|
|
||
| public static ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> WithMcpServer<TResource>(this ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> builder, ApplicationModel.IResourceBuilder<TResource> mcpServer, bool isDefault = true, McpTransportType transportType = McpTransportType.StreamableHttp, string path = "/mcp") | ||
| where TResource : ApplicationModel.IResourceWithEndpoints { throw null; } | ||
|
|
||
| public static ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> WithPnpm(this ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> builder) { throw null; } | ||
|
|
||
| public static ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> WithYarn(this ApplicationModel.IResourceBuilder<ApplicationModel.McpInspectorResource> builder) { throw null; } |
There was a problem hiding this comment.
The API surface file should not be manually updated. According to the coding guidelines, files under /api/*.cs are generated and should not be edited manually. Please remove these changes and regenerate the API surface using the appropriate tooling.
| var appBuilder = DistributedApplication.CreateBuilder(); | ||
|
|
||
| // Act | ||
| var inspector = appBuilder.AddMcpInspector("inspector") |
There was a problem hiding this comment.
Call to obsolete method AddMcpInspector.
Comment on lines
+626
to
+629
| var inspector = appBuilder.AddMcpInspector("inspector", options => | ||
| { | ||
| options.InspectorVersion = "0.15.0"; | ||
| }) |
There was a problem hiding this comment.
Call to obsolete method AddMcpInspector.
| var appModel = app.Services.GetRequiredService<DistributedApplicationModel>(); | ||
| var inspectorResource = Assert.Single(appModel.Resources.OfType<McpInspectorResource>()); | ||
|
|
||
| var args = await inspectorResource.GetArgumentValuesAsync(); |
There was a problem hiding this comment.
Call to obsolete method GetArgumentValuesAsync.
Comment on lines
+626
to
+630
| var inspector = appBuilder.AddMcpInspector("inspector", options => | ||
| { | ||
| options.InspectorVersion = "0.15.0"; | ||
| }) | ||
| .WithBun(); |
Changed McpInspectorResource constructor to accept a packageName parameter. Refactored test cases to use the new constructor signature and introduced a helper method GetArgsAsync to streamline argument extraction and assertions.
Eliminated the .WithNpm() method call from the AddMcpInspector extension method, simplifying the resource builder configuration.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #1008 (follow on)
Introduces the WithBun extension method to allow configuring the MCP Inspector to use Bun (bunx) as the package manager. Updates argument handling logic, documentation, API surface, and adds corresponding unit tests to ensure correct command and argument setup for Bun. Effectively a +1 to the existing pnpm and yarn extensions.
PR Checklist
Other information