ToolsMcpHost - EasyAF.AI

Definition

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

Syntax

Microsoft.OData.Mcp.Tools.Hosting.ToolsMcpHost

Summary

The local MCP host for a remote OData service: one generic host that owns the authenticating "OData" client, the unauthenticated "OAuth" client, the token cache, the catalog built from the service’s $metadata, and — when the process is serving stdio — the MCP server itself.

Remarks

There is exactly one Build(), and everything the process needs is registered before it. That matters because IHttpClientFactory cannot be shared between service providers: the $metadata GET has to run through the same authenticating client the tools later run through, or the credential the handler negotiated would be attached to one client and thrown away with the other.

Examples

using var lifetime = new CancellationTokenSource();
using var toolsHost = await ToolsMcpHost.CreateAsync(
    "https://api.example.com/odata",
    new OutboundOAuthOptions { ClientId = "cli" },
    includeStdioMcp: true,
    verbose: false,
    lifetime,
    lifetime.Token);

await toolsHost.Host.RunAsync(lifetime.Token);

Constructors

.ctor

Initializes a new instance of the ToolsMcpHost class.

Syntax

public ToolsMcpHost(Microsoft.Extensions.Hosting.IHost host, System.Uri serviceRoot, Microsoft.OData.Mcp.Core.Catalog.ODataMcpSession session)

Parameters

Name	Type	Description
`host`	`Microsoft.Extensions.Hosting.IHost`	The generic host that owns every service this host resolves.
`serviceRoot`	`System.Uri`	The OData service root.
`session`	`Microsoft.OData.Mcp.Core.Catalog.ODataMcpSession`	The MCP session.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when host, serviceRoot, or session is
`null`.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Catalog

Gets the catalog advertised by this host.

Syntax

public Microsoft.OData.Mcp.Core.Catalog.ODataMcpCatalog Catalog { get; }

Property Value

Type: Microsoft.OData.Mcp.Core.Catalog.ODataMcpCatalog

Host

Gets the generic host that owns every service this host resolves, including the two named HTTP clients and, when stdio is enabled, the MCP server.

Syntax

public Microsoft.Extensions.Hosting.IHost Host { get; }

Property Value

Type: Microsoft.Extensions.Hosting.IHost

ServiceRoot

Gets the remote service root, always with a trailing slash.

Syntax

public System.Uri ServiceRoot { get; }

Property Value

Type: System.Uri

Session

Gets the MCP session.

Syntax

public Microsoft.OData.Mcp.Core.Catalog.ODataMcpSession Session { get; }

Property Value

Type: Microsoft.OData.Mcp.Core.Catalog.ODataMcpSession

Methods

CreateAsync

Builds the host, authenticates against the remote service, fetches and parses $metadata, and returns a host whose catalog and session are ready to serve.

Syntax

public static System.Threading.Tasks.Task<Microsoft.OData.Mcp.Tools.Hosting.ToolsMcpHost> CreateAsync(string serviceUrl, Microsoft.OData.Mcp.Authentication.Outbound.OutboundOAuthOptions options, bool includeStdioMcp, bool verbose, System.Threading.CancellationTokenSource lifetime, System.Threading.CancellationToken cancellationToken, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection> configureServices = null)

Parameters

Name	Type	Description
`serviceUrl`	`string`	The OData service root URL.
`options`	`Microsoft.OData.Mcp.Authentication.Outbound.OutboundOAuthOptions`	The operator’s outbound authentication settings.
`includeStdioMcp`	`bool`	Whether to register the stdio MCP server and its `shutdown_server` tool.
`verbose`	`bool`	Whether to log at Debug instead of Information.
`lifetime`	`System.Threading.CancellationTokenSource?`	The lifetime `shutdown_server` cancels; required when includeStdioMcp is `true`.
`cancellationToken`	`System.Threading.CancellationToken`	The token that cancels the metadata fetch and any sign-in it triggers.
`configureServices`	`System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection>?`	A last chance to add or replace registrations, applied immediately before the single `Build()`.

Returns

Type: System.Threading.Tasks.Task<Microsoft.OData.Mcp.Tools.Hosting.ToolsMcpHost> The host.

Exceptions

Exception	Description
`ArgumentException`	Thrown when serviceUrl is empty, is not absolute, or is not `http` or `https`.
`ArgumentNullException`	Thrown when options is `null`, or lifetime is `null` while includeStdioMcp is `true`.
`InvalidOperationException`	Thrown when the `$metadata` fetch has to run an OAuth grant and this host’s credential store cannot round-trip a value.
`HttpRequestException`	Thrown when the `$metadata` request fails after authentication.

Examples

// A test can point both named clients at in-process servers without touching the network.
using var toolsHost = await ToolsMcpHost.CreateAsync(
    resource.ServiceRoot.ToString(),
    options,
    includeStdioMcp: false,
    verbose: false,
    lifetime: null,
    cancellationToken,
    services =&gt;
    {
        services.AddHttpClient(ODataMcpAuthConstants.ODataHttpClientName)
            .ConfigurePrimaryHttpMessageHandler(() =&gt; resource.Server.CreateHandler());
    });

Remarks

The order here is the whole point. Registrations first, configureServices last, then one Build(); only afterwards does anything touch the network, because the $metadata GET is what drives the authentication handler through discovery, consent, and the token cache. A restart that finds a still-valid cached token spends exactly one request here: no device code, no token endpoint, no discovery. The credential store is not probed here either: OutboundOAuthClient proves it usable on the first acquisition, so a service that answers $metadata without a challenge never touches the operating system keyring and never creates a token cache directory.

Dispose

Syntax

public void Dispose()

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?

System.IDisposable

​Definition

​Syntax

​Summary

​Remarks

​Examples

​Constructors

​ .ctor

​Syntax

​Parameters

​Exceptions

​ .ctor Inherited

​Syntax

​Properties

​ Catalog

​Syntax

​Property Value

​ Host

​Syntax

​Property Value

​ ServiceRoot

​Syntax

​Property Value

​ Session

​Syntax

​Property Value

​Methods

​ CreateAsync

​Syntax

​Parameters

​Returns

​Exceptions

​Examples

​Remarks

​ Dispose

​Syntax

​ 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

Examples

Constructors

.ctor

Syntax

Parameters

Exceptions

.ctor Inherited

Syntax

Properties

Catalog

Syntax

Property Value

Host

Syntax

Property Value

ServiceRoot

Syntax

Property Value

Session

Syntax

Property Value

Methods

CreateAsync

Syntax

Parameters

Returns

Exceptions

Examples

Remarks

Dispose

Syntax

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