Skip to main content

Definition

Assembly: Microsoft.OData.Mcp.Core.dll Namespace: Microsoft.OData.Mcp.Core.Catalog Inheritance: System.Object

Syntax

Summary

Options that control how an ODataMcpCatalog is built from an EDM.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

EnforceRequiredOnCreate

Gets or sets a value indicating whether create calls fail before HTTP when a required-on-create property is missing.

Syntax

Property Value

Type: bool

Remarks

Defaults to true: the declared metadata is the contract. Turn it off only for a service whose metadata declares properties non-nullable that its POST handler actually rejects or defaults (live TripPin does this with Gender). JSON kind, unknown property, enum, and MaxLength checks stay on regardless.

EnumJsonFormat

Gets or sets how enumeration values are advertised in JSON Schema and accepted on input.

Syntax

Property Value

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

Remarks

Defaults to ODataEnumJsonFormat.Auto: member names are advertised and JSON numbers are also accepted. The advertised schema never changes during a catalog’s lifetime.

ExcludeEntitySets

Gets or sets entity set names to exclude from named tools and resources.

Syntax

Property Value

Type: System.Collections.Generic.List<string>

IncludeActions

Gets or sets a value indicating whether named action_* tools are generated.

Syntax

Property Value

Type: bool

Remarks

Defaults to true. Turning it off omits named action tools; odata_call remains.

IncludeCreate

Gets or sets a value indicating whether create tools are generated.

Syntax

Property Value

Type: bool

IncludeDelete

Gets or sets a value indicating whether delete tools are generated.

Syntax

Property Value

Type: bool

IncludeEntitySets

Gets or sets entity set names that receive named tools first.

Syntax

Property Value

Type: System.Collections.Generic.List<string>

IncludeFunctions

Gets or sets a value indicating whether named function_* tools are generated.

Syntax

Property Value

Type: bool

Remarks

Defaults to true. Turning it off omits named function tools; odata_call remains.

IncludeUpdate

Gets or sets a value indicating whether update tools are generated.

Syntax

Property Value

Type: bool

InstructionsPreface

Gets or sets service-specific guidance placed before the default MCP server instructions.

Syntax

Property Value

Type: string?

Remarks

The default text in ODataMcpInstructions.Default is always included; this only prepends. See String).

IsDynamicModel

Gets or sets a value indicating whether the EDM can change while the catalog is alive.

Syntax

Property Value

Type: bool

Remarks

When false (the default) type shapes are computed once at catalog construction and cached. Set to true for models whose declared members change at runtime so shapes are rebuilt per request.

MaxCompletionValues

Gets or sets the maximum number of entity-set completion values returned for an empty prefix.

Syntax

Property Value

Type: int

MaxExpandLength

Gets or sets the maximum length of an expand argument.

Syntax

Property Value

Type: int

MaxFilterLength

Gets or sets the maximum length of a filter argument.

Syntax

Property Value

Type: int

MaxOperationWait

Gets or sets how long an annotated-action MCP task may wait for elicitation and the host waiter. Used as the task TTL when the Started ticket has no expiresIn.

Syntax

Property Value

Type: System.TimeSpan

Remarks

Defaults to 10 minutes. tasks/cancel and this timeout cancel the waiter token.

MaxRequestBodyBytes

Gets or sets the maximum JSON body size in bytes for create, update, and operation calls.

Syntax

Property Value

Type: int

MaxResources

Gets or sets the maximum number of catalog resources, including $metadata.

Syntax

Property Value

Type: int

MaxResponseBytes

Gets or sets the maximum response size in bytes before a tool result is rejected.

Syntax

Property Value

Type: int

MaxSelectLength

Gets or sets the maximum length of a select argument.

Syntax

Property Value

Type: int

RouteName

Gets or sets the MCP resource route name (for example, “remote” or “odata”).

Syntax

Property Value

Type: string

ToolsPageSize

Gets or sets how many tools a full tools/list page returns.

Syntax

Property Value

Type: int

Remarks

Defaults to 100. The final page may be shorter. Clients must not assume this size. The value must be greater than zero. Set it before the catalog is built. A cursor issued for one size is rejected if the size later changes, because each cursor is an offset on that size.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?