Skip to main content

Definition

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

Syntax

Summary

A tool advertised on tools/list.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

BindingParameterType

Gets or sets the EDM binding parameter type for a named operation tool, or null when the tool is unbound or not an operation.

Syntax

Property Value

Type: string?

Description

Gets or sets the description.

Syntax

Property Value

Type: string

DestructiveHint

Gets or sets a value indicating whether the tool is destructive.

Syntax

Property Value

Type: bool

ElicitUrlProperties

Gets or sets JSON property names on the action result that are URLs to elicit, or null when the term is omitted (the runtime then uses McpVocabulary.DefaultElicitUrlProperties).

Syntax

Property Value

Type: System.Collections.Generic.IReadOnlyList<string>?

EntitySetName

Gets or sets the entity set this named tool targets, if any.

Syntax

Property Value

Type: string?

IdempotentHint

Gets or sets a value indicating whether the tool is idempotent.

Syntax

Property Value

Type: bool

InputSchema

Gets or sets the JSON Schema for arguments. Query properties must not include ’$’.

Syntax

Property Value

Type: string

IsTask

Gets or sets a value indicating whether a named action tool is annotated Microsoft.OData.Mcp.V1.Task.

Syntax

Property Value

Type: bool true when the EDM action is a task; otherwise, false.

Name

Gets or sets the tool name.

Syntax

Property Value

Type: string

OpenWorldHint

Gets or sets a value indicating whether the tool reaches an external world.

Syntax

Property Value

Type: bool

OperationKind

Gets or sets whether this tool is a named action, a named function, or neither.

Syntax

Property Value

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

OperationName

Gets or sets the EDM short name of the action or function, or null when the tool is not an operation.

Syntax

Property Value

Type: string?

OutputSchema

Gets or sets the JSON Schema for structuredContent, or null when the tool’s result is not a fixed JSON shape.

Syntax

Property Value

Type: string?

Remarks

List tools and named action_* / function_* tools whose EDM return type is known declare one. Describe tools return text or JSON depending on format, and CRUD data tools forward OData bodies, so they leave this null. Operations with no return type also leave it null.

ReadOnlyHint

Gets or sets a value indicating whether the tool is read-only.

Syntax

Property Value

Type: bool

Title

Gets or sets the title.

Syntax

Property Value

Type: string

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?