ODataMcpRouteConvention

Definition

Assembly: Microsoft.OData.Mcp.AspNetCore.dll Namespace: Microsoft.OData.Mcp.AspNetCore.Routing Inheritance: System.Object

Syntax

Microsoft.OData.Mcp.AspNetCore.Routing.ODataMcpRouteConvention

Summary

Automatically adds MCP endpoints to OData routes during registration.

Remarks

This convention ensures that for each OData route registered, corresponding MCP endpoints are automatically created as siblings to the $metadata endpoint.

Constructors

.ctor

Initializes a new instance of the ODataMcpRouteConvention class.

Syntax

public ODataMcpRouteConvention(Microsoft.Extensions.Options.IOptions<Microsoft.OData.Mcp.Core.ODataMcpOptions> options, Microsoft.OData.Mcp.Core.Routing.IMcpEndpointRegistry endpointRegistry)

Parameters

Name	Type	Description
`options`	`Microsoft.Extensions.Options.IOptions<Microsoft.OData.Mcp.Core.ODataMcpOptions>`	The MCP options.
`endpointRegistry`	`Microsoft.OData.Mcp.Core.Routing.IMcpEndpointRegistry`	The MCP endpoint registry.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when required parameters are null.

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

ApplyConvention

Applies MCP conventions to the endpoint route builder.

Syntax

public void ApplyConvention(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpointRouteBuilder, string routePrefix, string routeName)

Parameters

Name	Type	Description
`endpointRouteBuilder`	`Microsoft.AspNetCore.Routing.IEndpointRouteBuilder`	The endpoint route builder.
`routePrefix`	`string`	The OData route prefix.
`routeName`	`string`	The OData route name.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

Microsoft.OData.Mcp.AspNetCore.Routing.IMcpRouteConvention

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​Parameters

​Exceptions

​ .ctor Inherited

​Syntax

​Methods

​ ApplyConvention

​Syntax

​Parameters

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

​Related APIs

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

Parameters

Exceptions

.ctor Inherited

Syntax

Methods

ApplyConvention

Syntax

Parameters

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns

Related APIs