> ## Documentation Index
> Fetch the complete documentation index at: https://easyaf.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# NavigationToolGenerationOptions

> Options for controlling navigation tool generation behavior.

export function DocsBadge({text, variant = 'neutral'}) {
  const variantClasses = {
    success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20',
    neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20',
    info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20',
    warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20',
    danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20'
  };
  const classes = variantClasses[variant] || variantClasses.neutral;
  return <span className={`mint-inline-flex mint-items-center mint-px-2 mint-py-0.5 mint-rounded-full mint-text-xs mint-font-medium mint-tracking-wide mint-border mint-ml-1.5 mint-align-middle mint-whitespace-nowrap ${classes}`}>
      {text}
    </span>;
}

## Definition

**Assembly:** Microsoft.OData.Mcp.Core.dll

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

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
Microsoft.OData.Mcp.Core.Legacy.Generators.NavigationToolGenerationOptions
```

## 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

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  .ctor

#### Syntax

```csharp theme={"dark"}
public NavigationToolGenerationOptions()
```

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  .ctor <DocsBadge text="Inherited" variant="neutral" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  CustomProperties

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

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  DefaultPageSize

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

#### Syntax

```csharp theme={"dark"}
public int DefaultPageSize { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  ExcludedEntityTypes

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

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  ExcludedNavigationProperties

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

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.Dictionary<string, System.Collections.Generic.HashSet<string>> ExcludedNavigationProperties { 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 navigation properties.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  GenerateAddRelationshipTools

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

#### Syntax

```csharp theme={"dark"}
public bool GenerateAddRelationshipTools { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  GenerateDetailedDescriptions

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

#### Syntax

```csharp theme={"dark"}
public bool GenerateDetailedDescriptions { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  GenerateGetRelatedTools

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

#### Syntax

```csharp theme={"dark"}
public bool GenerateGetRelatedTools { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  GenerateRemoveRelationshipTools

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

#### Syntax

```csharp theme={"dark"}
public bool GenerateRemoveRelationshipTools { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  IncludeCollectionNavigations

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

#### Syntax

```csharp theme={"dark"}
public bool IncludeCollectionNavigations { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  IncludeExamples

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

#### Syntax

```csharp theme={"dark"}
public bool IncludeExamples { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  IncludeSingleNavigations

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

#### Syntax

```csharp theme={"dark"}
public bool IncludeSingleNavigations { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  MaxPageSize

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

#### Syntax

```csharp theme={"dark"}
public int MaxPageSize { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  NamingConvention

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

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  SupportFilter

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

#### Syntax

```csharp theme={"dark"}
public bool SupportFilter { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  SupportOrderBy

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

#### Syntax

```csharp theme={"dark"}
public bool SupportOrderBy { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  SupportQueryOptions

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

#### Syntax

```csharp theme={"dark"}
public bool SupportQueryOptions { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  SupportTop

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

#### Syntax

```csharp theme={"dark"}
public bool SupportTop { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  UseSchemaDescriptions

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

#### Syntax

```csharp theme={"dark"}
public bool UseSchemaDescriptions { get; set; }
```

#### Property Value

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

## Methods

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  Equals <DocsBadge text="Inherited" variant="neutral" /> <DocsBadge text="Virtual" variant="warning" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name  | Type      | Description |
| ----- | --------- | ----------- |
| `obj` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  Equals <DocsBadge text="Inherited" variant="neutral" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  GetHashCode <DocsBadge text="Inherited" variant="neutral" /> <DocsBadge text="Virtual" variant="warning" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  GetType <DocsBadge text="Inherited" variant="neutral" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  MemberwiseClone <DocsBadge text="Inherited" variant="neutral" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  ReferenceEquals <DocsBadge text="Inherited" variant="neutral" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} style={{ paddingRight: '8px' }} />  ToString <DocsBadge text="Inherited" variant="neutral" /> <DocsBadge text="Virtual" variant="warning" />

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`
