Skip to main content

Definition

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

Syntax

Summary

Options for controlling navigation tool generation behavior.

Remarks

These options allow fine-grained control over which navigation tools are generated and how they behave, including relationship management and traversal capabilities.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

CustomProperties

Gets or sets custom properties that can be used by specific generators.

Syntax

Property Value

Type: System.Collections.Generic.Dictionary<string, object> A dictionary of custom properties for generator-specific configuration.

DefaultPageSize

Gets or sets the default page size for related entity results.

Syntax

Property Value

Type: int The default number of related entities to return.

ExcludedEntityTypes

Gets or sets the list of entity types to exclude from navigation tool generation.

Syntax

Property Value

Type: System.Collections.Generic.HashSet<string> A collection of entity type names to exclude.

ExcludedNavigationProperties

Gets or sets the list of navigation properties to exclude from tool generation.

Syntax

Property Value

Type: System.Collections.Generic.Dictionary<string, System.Collections.Generic.HashSet<string>> A dictionary mapping entity type names to lists of excluded navigation properties.

GenerateAddRelationshipTools

Gets or sets a value indicating whether to generate tools for adding relationships.

Syntax

Property Value

Type: bool true to generate add relationship tools; otherwise, false.

GenerateDetailedDescriptions

Gets or sets a value indicating whether to generate detailed descriptions for tools.

Syntax

Property Value

Type: bool true to generate detailed descriptions; otherwise, false.

GenerateGetRelatedTools

Gets or sets a value indicating whether to generate tools for getting related entities.

Syntax

Property Value

Type: bool true to generate get related tools; otherwise, false.

GenerateRemoveRelationshipTools

Gets or sets a value indicating whether to generate tools for removing relationships.

Syntax

Property Value

Type: bool true to generate remove relationship tools; otherwise, false.

IncludeCollectionNavigations

Gets or sets a value indicating whether to include collection navigation properties.

Syntax

Property Value

Type: bool true to include collection navigations; otherwise, false.

IncludeExamples

Gets or sets a value indicating whether to include examples in tool descriptions.

Syntax

Property Value

Type: bool true to include examples; otherwise, false.

IncludeSingleNavigations

Gets or sets a value indicating whether to include single navigation properties.

Syntax

Property Value

Type: bool true to include single navigations; otherwise, false.

MaxPageSize

Gets or sets the maximum page size for related entity results.

Syntax

Property Value

Type: int The maximum number of related entities to return.

NamingConvention

Gets or sets the naming convention to use for generated tool names.

Syntax

Property Value

Type: Microsoft.OData.Mcp.Core.Legacy.Generators.ToolNamingConvention The naming convention for tool names.

SupportFilter

Gets or sets a value indicating whether to support filtering on related entities.

Syntax

Property Value

Type: bool true to support filtering; otherwise, false.

SupportOrderBy

Gets or sets a value indicating whether to support ordering on related entities.

Syntax

Property Value

Type: bool true to support ordering; otherwise, false.

SupportQueryOptions

Gets or sets a value indicating whether to support query options on related entities.

Syntax

Property Value

Type: bool true to support query options; otherwise, false.

SupportTop

Gets or sets a value indicating whether to support limiting results on related entities.

Syntax

Property Value

Type: bool true to support top results; otherwise, false.

UseSchemaDescriptions

Gets or sets a value indicating whether to use schema descriptions for tool documentation.

Syntax

Property Value

Type: bool true to use schema descriptions; otherwise, false.

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?