Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

McpInspectorResourceBuilderExtensions Methods

Class Methods 8 members
Provides extension methods for adding the MCP Inspector to an Hosting.IDistributedApplicationBuilder.
AddMcpInspector(IDistributedApplicationBuilder, string, int, int, string) Section titled AddMcpInspector(IDistributedApplicationBuilder, string, int, int, string) extension IResourceBuilder<McpInspectorResource>
Adds a MCP Inspector container resource to the Hosting.IDistributedApplicationBuilder. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> AddMcpInspector(
        this IDistributedApplicationBuilder builder,
        string name,
        int clientPort = 6274,
        int serverPort = 6277,
        string inspectorVersion = "0.17.2")
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L23-L30
Parameters
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
name string The name of the MCP Inspector container resource.
clientPort int optional The port for the client application. Defaults to 6274.
serverPort int optional The port for the server proxy application. Defaults to 6277.
inspectorVersion string optional The version of the Inspector app to use
AddMcpInspector(IDistributedApplicationBuilder, string, McpInspectorOptions) Section titled AddMcpInspector(IDistributedApplicationBuilder, string, McpInspectorOptions) extension IResourceBuilder<McpInspectorResource>
Adds a MCP Inspector container resource to the Hosting.IDistributedApplicationBuilder using an options object. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> AddMcpInspector(
        this IDistributedApplicationBuilder builder,
        string name,
        McpInspectorOptions options)
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L49-L184
Parameters
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
name string The name of the MCP Inspector container resource.
options McpInspectorOptions The McpInspectorOptions to configure the MCP Inspector resource.
Returns
IResourceBuilder<McpInspectorResource> A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
Remarks
By default, the MCP Inspector uses npm/npx. To use a different package manager, chain the appropriate method: 
builder.AddMcpInspector("inspector")
    .WithYarn();
AddMcpInspector(IDistributedApplicationBuilder, string, Action<McpInspectorOptions>) Section titled AddMcpInspector(IDistributedApplicationBuilder, string, Action<McpInspectorOptions>) extension IResourceBuilder<McpInspectorResource>
Adds a MCP Inspector container resource to the Hosting.IDistributedApplicationBuilder using a configuration delegate. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> AddMcpInspector(
        this IDistributedApplicationBuilder builder,
        string name,
        Action<McpInspectorOptions> configureOptions)
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L196-L202
Parameters
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
name string The name of the MCP Inspector container resource.
configureOptions Action<McpInspectorOptions> A delegate to configure the McpInspectorOptions.
Returns
IResourceBuilder<McpInspectorResource> A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
AddMcpInspector(IDistributedApplicationBuilder, string) Section titled AddMcpInspector(IDistributedApplicationBuilder, string) extension IResourceBuilder<McpInspectorResource>
Adds a MCP Inspector container resource to the Hosting.IDistributedApplicationBuilder using a configuration delegate. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> AddMcpInspector(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L213-L217
Parameters
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
name string The name of the MCP Inspector container resource.
Returns
IResourceBuilder<McpInspectorResource> A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
WithBun(IResourceBuilder<McpInspectorResource>) Section titled WithBun(IResourceBuilder<McpInspectorResource>) extension IResourceBuilder<McpInspectorResource>
Configures the MCP Inspector to use bun as the package manager. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> WithBun(
        this IResourceBuilder<McpInspectorResource> builder)
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L363-L365
Parameters
builder IResourceBuilder<McpInspectorResource> The MCP Inspector resource builder.
Returns
IResourceBuilder<McpInspectorResource> A reference to the ApplicationModel.IResourceBuilder`1.
WithMcpServer(IResourceBuilder<McpInspectorResource>, IResourceBuilder<TResource>, bool, McpTransportType, string) Section titled WithMcpServer(IResourceBuilder<McpInspectorResource>, IResourceBuilder<TResource>, bool, McpTransportType, string) extension IResourceBuilder<McpInspectorResource>
Configures the MCP Inspector resource to use a specified MCP server resource that uses SSE as the transport type. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> WithMcpServer<TResource>(
        this IResourceBuilder<McpInspectorResource> builder,
        IResourceBuilder<TResource> mcpServer,
        bool isDefault = true,
        McpTransportType transportType = McpTransportType.StreamableHttp,
        string path = "/mcp")
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L238-L251
Parameters
builder IResourceBuilder<McpInspectorResource> The ApplicationModel.IResourceBuilder`1 used to configure the MCP Inspector resource.
mcpServer IResourceBuilder<TResource> The ApplicationModel.IResourceBuilder`1 for the MCP server resource.
isDefault bool optional Indicates whether this MCP server should be considered the default server for the MCP Inspector.
transportType McpTransportType optional The transport type to use for the MCP server. Defaults to McpTransportType.StreamableHttp.
path string optional The path to use for MCP communication. Defaults to "/mcp".
Returns
IResourceBuilder<McpInspectorResource> A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
WithPnpm(IResourceBuilder<McpInspectorResource>) Section titled WithPnpm(IResourceBuilder<McpInspectorResource>) extension IResourceBuilder<McpInspectorResource>
Configures the MCP Inspector to use pnpm as the package manager. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> WithPnpm(
        this IResourceBuilder<McpInspectorResource> builder)
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L351-L353
Parameters
builder IResourceBuilder<McpInspectorResource> The MCP Inspector resource builder.
Returns
IResourceBuilder<McpInspectorResource> A reference to the ApplicationModel.IResourceBuilder`1.
WithYarn(IResourceBuilder<McpInspectorResource>) Section titled WithYarn(IResourceBuilder<McpInspectorResource>) extension IResourceBuilder<McpInspectorResource>
Configures the MCP Inspector to use yarn as the package manager. 
public static class McpInspectorResourceBuilderExtensions
{
    public static IResourceBuilder<McpInspectorResource> WithYarn(
        this IResourceBuilder<McpInspectorResource> builder)
    {
        // ...
    }
}
McpInspectorResourceBuilderExtensions.cs#L339-L341
Parameters
builder IResourceBuilder<McpInspectorResource> The MCP Inspector resource builder.
Returns
IResourceBuilder<McpInspectorResource> A reference to the ApplicationModel.IResourceBuilder`1.
Connect with us

Community

SHA — 037d613 © Microsoft