Skip to content
DocsTry Aspire
DocsTry

McpInspectorResourceBuilderExtensions Methods

ClassMethods8 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)extensionIResourceBuilder<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")
{
// ...
}
}
builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
namestringThe name of the MCP Inspector container resource.
clientPortintoptionalThe port for the client application. Defaults to 6274.
serverPortintoptionalThe port for the server proxy application. Defaults to 6277.
inspectorVersionstringoptionalThe version of the Inspector app to use
AddMcpInspector(IDistributedApplicationBuilder, string, McpInspectorOptions)Section titled AddMcpInspector(IDistributedApplicationBuilder, string, McpInspectorOptions)extensionIResourceBuilder<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)
{
// ...
}
}
builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
namestringThe name of the MCP Inspector container resource.
optionsMcpInspectorOptionsThe McpInspectorOptions to configure the MCP Inspector resource.
IResourceBuilder<McpInspectorResource>A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
By default, the MCP Inspector uses npm/npx. To use a different package manager, chain the appropriate method:
builder.AddMcpInspector("inspector")
.WithYarn();
This overload is not available in polyglot app hosts. Use McpInspectorResourceBuilderExtensions.AddMcpInspectorPolyglot instead.
AddMcpInspector(IDistributedApplicationBuilder, string, Action<McpInspectorOptions>)Section titled AddMcpInspector(IDistributedApplicationBuilder, string, Action<McpInspectorOptions>)extensionIResourceBuilder<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)
{
// ...
}
}
builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
namestringThe name of the MCP Inspector container resource.
configureOptionsAction<McpInspectorOptions>A delegate to configure the McpInspectorOptions.
IResourceBuilder<McpInspectorResource>A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
This overload is not available in polyglot app hosts. Use McpInspectorResourceBuilderExtensions.AddMcpInspectorPolyglot instead.
AddMcpInspector(IDistributedApplicationBuilder, string)Section titled AddMcpInspector(IDistributedApplicationBuilder, string)extensionIResourceBuilder<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)
{
// ...
}
}
builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder to which the MCP Inspector resource will be added.
namestringThe name of the MCP Inspector container resource.
IResourceBuilder<McpInspectorResource>A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
This overload is not available in polyglot app hosts. Use McpInspectorResourceBuilderExtensions.AddMcpInspectorPolyglot instead.
WithBun(IResourceBuilder<McpInspectorResource>)Section titled WithBun(IResourceBuilder<McpInspectorResource>)extensionIResourceBuilder<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)
{
// ...
}
}
builderIResourceBuilder<McpInspectorResource>The MCP Inspector resource builder.
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)extensionIResourceBuilder<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")
{
// ...
}
}
builderIResourceBuilder<McpInspectorResource>The ApplicationModel.IResourceBuilder`1 used to configure the MCP Inspector resource.
mcpServerIResourceBuilder<TResource>The ApplicationModel.IResourceBuilder`1 for the MCP server resource.
isDefaultbooloptionalIndicates whether this MCP server should be considered the default server for the MCP Inspector.
transportTypeMcpTransportTypeoptionalThe transport type to use for the MCP server. Defaults to McpTransportType.StreamableHttp.
pathstringoptionalThe path to use for MCP communication. Defaults to "/mcp".
IResourceBuilder<McpInspectorResource>A reference to the ApplicationModel.IResourceBuilder`1 for further configuration.
WithPnpm(IResourceBuilder<McpInspectorResource>)Section titled WithPnpm(IResourceBuilder<McpInspectorResource>)extensionIResourceBuilder<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)
{
// ...
}
}
builderIResourceBuilder<McpInspectorResource>The MCP Inspector resource builder.
IResourceBuilder<McpInspectorResource>A reference to the ApplicationModel.IResourceBuilder`1.
WithYarn(IResourceBuilder<McpInspectorResource>)Section titled WithYarn(IResourceBuilder<McpInspectorResource>)extensionIResourceBuilder<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)
{
// ...
}
}
builderIResourceBuilder<McpInspectorResource>The MCP Inspector resource builder.
IResourceBuilder<McpInspectorResource>A reference to the ApplicationModel.IResourceBuilder`1.