ODataMcpServerBuilder

Definition

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

Syntax

Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder

Summary

Configures OData MCP Tasks on AddODataMcp. Hosts call ODataMcpServerBuilder.WithTasks and WaitForAnnotatedAction“1 here, not on UseODataMcp and not via SDK WithTasks from app code.

Examples

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

Constructors

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Server

Gets the SDK builder already used for WithHttpTransport and catalog handlers. Hosts may attach logging filters. They must not call SDK WithTasks on it.

Syntax

public Microsoft.Extensions.DependencyInjection.IMcpServerBuilder Server { get; }

Property Value

Type: Microsoft.Extensions.DependencyInjection.IMcpServerBuilder

Methods

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?

WaitForAnnotatedAction

Registers the host waiter used after URL elicitation is accepted.

Syntax

public Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder WaitForAnnotatedAction<TWaiter>() where TWaiter : class, Microsoft.OData.Mcp.AspNetCore.Hosting.IMcpAnnotatedActionWaiter

Returns

Type: Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder This builder.

Type Parameters

TWaiter - The waiter type.

Remarks

Required for Succeeded after elicitation. Without it, the call completes with the Started payload after the URL is shown.

WithTasks

Enables MCP Tasks for annotated actions only, using InMemoryMcpTaskStorePlus. Authenticated callers are isolated by user id. Unauthenticated callers share owner UnauthenticatedTaskOwner and the task id is the secret.

Syntax

public Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder WithTasks()

Returns

Type: Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder This builder.

WithTasks

Enables MCP Tasks and selects a plus store provider.

Syntax

public Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder WithTasks(System.Action<CloudNimble.McpEssentials.Core.Tasks.McpTaskStoreBuilder> configure)

Parameters

Name	Type	Description
`configure`	`System.Action<CloudNimble.McpEssentials.Core.Tasks.McpTaskStoreBuilder>`	Selects `UseInMemory` or a provider `Use*` method.

Returns

Type: Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder This builder.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when configure is `null`.
`InvalidOperationException`	Thrown when configure did not call a `Use*` method.

Examples

mcp.WithTasks(tasks =&gt; tasks.UseInMemory("local-user"));
mcp.WithTasks(tasks =&gt; tasks.UseEntityFramework&lt;AppDbContext&gt;(
    sp =&gt; sp.GetRequiredService&lt;IHttpContextAccessor&gt;().HttpContext?.User));

WithTasks

Enables MCP Tasks for annotated actions only. CRUD, functions, and unannotated actions stay one-shot.

Syntax

public Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder WithTasks(ModelContextProtocol.Extensions.Tasks.IMcpTaskStore store)

Parameters

Name	Type	Description
`store`	`ModelContextProtocol.Extensions.Tasks.IMcpTaskStore`	The protocol task store. Register a singleton; stateless HTTP
creates a fresh server per POST.

Returns

Type: Microsoft.OData.Mcp.AspNetCore.Hosting.ODataMcpServerBuilder This builder.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when store is `null`.

Remarks

Wires tasks/get, tasks/update, and tasks/cancel from ModelContextProtocol.Extensions.Tasks. Does not wrap every catalog tool: the execution-mode selector returns Optional only for annotated actions whose request advertised the Tasks extension. Stamps DefaultTimeToLive on IMcpTaskStorePlus so Claude Code receives ttlMs.

​Definition

​Syntax

​Summary

​Examples

​Constructors

​ .ctor Inherited

​Syntax

​Properties

​ Server

​Syntax

​Property Value

​Methods

​ 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

​ WaitForAnnotatedAction

​Syntax

​Returns

​Type Parameters

​Remarks

​ WithTasks

​Syntax

​Returns

​ WithTasks

​Syntax

​Parameters

​Returns

​Exceptions

​Examples

​ WithTasks

​Syntax

​Parameters

​Returns

​Exceptions

​Remarks

Definition

Syntax

Summary

Examples

Constructors

.ctor Inherited

Syntax

Properties

Server

Syntax

Property Value

Methods

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

WaitForAnnotatedAction

Syntax

Returns

Type Parameters

Remarks

WithTasks

Syntax

Returns

WithTasks

Syntax

Parameters

Returns

Exceptions

Examples

WithTasks

Syntax

Parameters

Returns

Exceptions

Remarks