IServiceCollection

Definition

Assembly: Microsoft.Extensions.DependencyInjection.Abstractions.dll Namespace: Microsoft.Extensions.DependencyInjection

Syntax

Microsoft.Extensions.DependencyInjection.IServiceCollection

Summary

This type is defined in Microsoft.Extensions.DependencyInjection.Abstractions.

Remarks

See Microsoft documentation for more information about the rest of the API.

Methods

AddODataMcp Extension

Extension method from Microsoft.Extensions.DependencyInjection.ODataMcp_AspNetCore_ServiceCollectionExtensions

Registers OData MCP services. Call UseODataMcp after mapping OData routes to turn MCP on at {prefix}/mcp. Discovers prefixes from ASP.NET Core endpoint routing (OData 7 MapODataRoute / Restier MapApiRoute and OData 8 conventional endpoints), plus any routes registered with IEdmModel). Prefer this unless a prefix must stay hidden from agents; then set ODataMcpHostOptions.IncludePrefixes or ODataMcpHostOptions.ExcludeRoutes.

Syntax

public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddODataMcp(Microsoft.Extensions.DependencyInjection.IServiceCollection services)

Parameters

Name	Type	Description
`services`	`Microsoft.Extensions.DependencyInjection.IServiceCollection`	The service collection.

Returns

Type: Microsoft.Extensions.DependencyInjection.IServiceCollection The service collection.

Examples

builder.Services
    .AddControllers()
    .AddOData(options =&gt;
    {
        options.AddRouteComponents("odata", GetPublicModel());
        options.AddRouteComponents("reporting", GetReportingModel());
    });

builder.Services.AddODataMcp();

var app = builder.Build();
app.MapControllers();
app.UseODataMcp();

Remarks

This package does not reference Microsoft.AspNetCore.OData. The app brings OData 7 or 8. This method does not map endpoints. Call UseODataMcp to map MCP. Do not call the SDK MapMcp yourself.

AddODataMcp Extension

Extension method from Microsoft.Extensions.DependencyInjection.ODataMcp_AspNetCore_ServiceCollectionExtensions

Syntax

public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddODataMcp(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpHostOptions> configure)

Parameters

Name	Type	Description
`services`	`Microsoft.Extensions.DependencyInjection.IServiceCollection`	The service collection.
`configure`	`System.Action<Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpHostOptions>`	Configures host options.

Returns

Type: Microsoft.Extensions.DependencyInjection.IServiceCollection The service collection.

Examples

builder.Services.AddODataMcp(options =&gt;
{
    options.IncludePrefixes.Add("odata");
    options.RateLimitingPolicyName = "mcp";
});

var app = builder.Build();
app.MapControllers();
app.UseODataMcp();

Remarks

This package does not reference Microsoft.AspNetCore.OData. The app brings OData 7 or 8. This method does not map endpoints. Call UseODataMcp to map MCP. Do not call the SDK MapMcp yourself.

AddODataMcp Extension

Extension method from Microsoft.Extensions.DependencyInjection.ODataMcp_AspNetCore_ServiceCollectionExtensions

Syntax

public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddODataMcp(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpHostOptions> configure, System.Action<Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder> configureServer)

Parameters

Name	Type	Description
`services`	`Microsoft.Extensions.DependencyInjection.IServiceCollection`	The service collection.
`configure`	`System.Action<Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpHostOptions>`	Configures host options.
`configureServer`	`System.Action<Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder>?`	Optional Tasks configuration (`WithTasks`,
`WaitForAnnotatedAction`). Null means no Tasks wrapping.

Returns

Type: Microsoft.Extensions.DependencyInjection.IServiceCollection The service collection.

Examples

builder.Services.AddODataMcp(options =&gt; { }, mcp =&gt;
{
    mcp.WithTasks();
    mcp.WaitForAnnotatedAction&lt;HostAuthorizeWaiter&gt;();
});

Remarks

This package does not reference Microsoft.AspNetCore.OData. The app brings OData 7 or 8. This method does not map endpoints. Call UseODataMcp to map MCP. Do not call the SDK MapMcp yourself. Configure Tasks here, not on UseODataMcp.

AddODataMcpCore Extension

Extension method from Microsoft.Extensions.DependencyInjection.ODataMcp_Core_ServiceCollectionExtensions

Adds the CSDL parser and a named OData HttpClient.

Syntax

public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddODataMcpCore(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<System.Net.Http.HttpClient> configureClient = null)

Parameters

Name	Type	Description
`services`	`Microsoft.Extensions.DependencyInjection.IServiceCollection`	The service collection.
`configureClient`	`System.Action<System.Net.Http.HttpClient>?`	Optional named-client configuration.

Returns

Type: Microsoft.Extensions.DependencyInjection.IServiceCollection The service collection.

AddProtectedResourceMetadata Extension

Extension method from Microsoft.Extensions.DependencyInjection.ODataMcp_AspNetCore_ServiceCollectionExtensions

Publishes RFC 9728 protected resource metadata for this host, and annotates the WWW-Authenticate challenge on a 401 beneath a covered route base with the URL of that document. This is how a client such as dotnet odata-mcp start discovers how to sign in without being told.

Syntax

public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddProtectedResourceMetadata(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Microsoft.OData.Mcp.AspNetCore.Authentication.ProtectedResourceMetadataOptions> configure)

Parameters

Name	Type	Description
`services`	`Microsoft.Extensions.DependencyInjection.IServiceCollection`	The service collection.
`configure`	`System.Action<Microsoft.OData.Mcp.AspNetCore.Authentication.ProtectedResourceMetadataOptions>`	Configures what the API publishes about itself.

Returns

Type: Microsoft.Extensions.DependencyInjection.IServiceCollection The service collection.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when services or configure is `null`.

Examples

builder.Services.AddProtectedResourceMetadata(options =&gt;
{
    options.AuthorizationServers.Add(new Uri("https://login.microsoftonline.com/contoso.com/v2.0"));
    options.ScopesSupported.Add("api://contoso-odata/Data.Read");
});

// GET /.well-known/oauth-protected-resource now answers 200, anonymously.
// The protected resource is the application root.

Remarks

Independent of IServiceCollection): an API that hosts no MCP server at all still benefits, because the discovery this feeds is the client’s, not ours. The default route base is the application root. Set ProtectedResourceMetadataOptions.Prefixes to any route base Endpoint Routing or Minimal APIs accept, including an empty string, when the resource is not the whole host. The middleware is inserted at the front of the pipeline through an IStartupFilter, which is what keeps the metadata document anonymously readable. There is no Use call to add. Calling this more than once adds the extra configuration and registers the filter once.

Getting Started

API Reference

IServiceCollection

Definition

Syntax

Summary

Remarks

Methods

AddODataMcp Extension

Syntax

Parameters

Returns

Examples

Remarks

AddODataMcp Extension

Syntax

Parameters

Returns

Examples

Remarks

AddODataMcp Extension

Syntax

Parameters

Returns

Examples

Remarks

AddODataMcpCore Extension

Syntax

Parameters

Returns

AddProtectedResourceMetadata Extension

Syntax

Parameters

Returns

Exceptions

Examples

Remarks

​Definition

​Syntax

​Summary

​Remarks

​Methods

​ AddODataMcp Extension

​Syntax

​Parameters

​Returns

​Examples

​Remarks

​ AddODataMcp Extension

​Syntax

​Parameters

​Returns

​Examples

​Remarks

​ AddODataMcp Extension

​Syntax

​Parameters

​Returns

​Examples

​Remarks

​ AddODataMcpCore Extension

​Syntax

​Parameters

​Returns

​ AddProtectedResourceMetadata Extension

​Syntax

​Parameters

​Returns

​Exceptions

​Examples

​Remarks

Definition

Syntax

Summary

Remarks

Methods

AddODataMcp Extension

Syntax

Parameters

Returns

Examples

Remarks

AddODataMcp Extension

Syntax

Parameters

Returns

Examples

Remarks

AddODataMcp Extension

Syntax

Parameters

Returns

Examples

Remarks

AddODataMcpCore Extension

Syntax

Parameters

Returns

AddProtectedResourceMetadata Extension

Syntax

Parameters

Returns

Exceptions

Examples

Remarks