QueryToolGenerationOptions

Options for controlling query tool generation behavior.

Definition

Assembly: Microsoft.OData.Mcp.Core.dll

Namespace: Microsoft.OData.Mcp.Core.Legacy.Generators

Inheritance: System.Object

Syntax

Microsoft.OData.Mcp.Core.Legacy.Generators.QueryToolGenerationOptions

Summary

Options for controlling query tool generation behavior.

Remarks

These options allow fine-grained control over which query features are enabled and how they behave, including OData query options and result formatting.

Constructors

.ctor

Syntax

public QueryToolGenerationOptions()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

CustomProperties

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

Syntax

public System.Collections.Generic.Dictionary<string, object> CustomProperties { get; set; }

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 query results.

Syntax

public int DefaultPageSize { get; set; }

Property Value

Type: int The default number of entities to return in a single page.

ExcludedEntityTypes

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

Syntax

public System.Collections.Generic.HashSet<string> ExcludedEntityTypes { get; set; }

Property Value

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

ExcludedProperties

Gets or sets the list of properties to exclude from filtering and sorting.

Syntax

public System.Collections.Generic.Dictionary<string, System.Collections.Generic.HashSet<string>> ExcludedProperties { get; set; }

Property Value

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

GenerateCountTools

Gets or sets a value indicating whether to generate count tools.

Syntax

public bool GenerateCountTools { get; set; }

Property Value

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

GenerateDetailedDescriptions

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

Syntax

public bool GenerateDetailedDescriptions { get; set; }

Property Value

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

GenerateListTools

Gets or sets a value indicating whether to generate list tools.

Syntax

public bool GenerateListTools { get; set; }

Property Value

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

GenerateSearchTools

Gets or sets a value indicating whether to generate search tools.

Syntax

public bool GenerateSearchTools { get; set; }

Property Value

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

IncludeExamples

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

Syntax

public bool IncludeExamples { get; set; }

Property Value

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

MaxPageSize

Gets or sets the maximum page size allowed for queries.

Syntax

public int MaxPageSize { get; set; }

Property Value

Type: int The maximum number of entities that can be requested in a single page.

NamingConvention

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

Syntax

public Microsoft.OData.Mcp.Core.Legacy.Generators.ToolNamingConvention NamingConvention { get; set; }

Property Value

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

SupportExpand

Gets or sets a value indicating whether to support $expand query option.

Syntax

public bool SupportExpand { get; set; }

Property Value

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

SupportFilter

Gets or sets a value indicating whether to support $filter query option.

Syntax

public bool SupportFilter { get; set; }

Property Value

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

SupportOrderBy

Gets or sets a value indicating whether to support $orderby query option.

Syntax

public bool SupportOrderBy { get; set; }

Property Value

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

SupportSearch

Gets or sets a value indicating whether to support $search query option.

Syntax

public bool SupportSearch { get; set; }

Property Value

Type: bool true to support full-text search; otherwise, false.

SupportSelect

Gets or sets a value indicating whether to support $select query option.

Syntax

public bool SupportSelect { get; set; }

Property Value

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

SupportSkip

Gets or sets a value indicating whether to support $skip query option.

Syntax

public bool SupportSkip { get; set; }

Property Value

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

SupportTop

Gets or sets a value indicating whether to support $top query option.

Syntax

public bool SupportTop { get; set; }

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

public bool UseSchemaDescriptions { get; set; }

Property Value

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

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?