FormElicitationBuilder

Definition

Assembly: CloudNimble.McpEssentials.Core.dll Namespace: CloudNimble.McpEssentials.Core.Tasks.Elicitations Inheritance: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Syntax

CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder<T>

Summary

Typed form builder. String) seeds mappable properties, then expression starters reconfigure them and string starters add extra fields.

Type Parameters

T - The form type.

Constructors

.ctor

Initializes a builder seeded from T.

Syntax

public FormElicitationBuilder(string message)

Parameters

Name	Type	Description
`message`	`string`	The message presented to the user.

.ctor Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Initializes a builder with message as the prompt.

Syntax

public FormElicitationBuilder(string message)

Parameters

Name	Type	Description
`message`	`string`	The message presented to the user.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when message is `null`.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Fields Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Gets the fields accumulated so far, in insertion order.

Syntax

internal System.Collections.Generic.List<CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationField> Fields { get; }

Property Value

Type: System.Collections.Generic.List<CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationField>

Message Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Gets the prompt presented with the form.

Syntax

public string Message { get; }

Property Value

Type: string

Methods

Boolean

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder<T> Boolean(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder<T>

Boolean Virtual

Adds or reconfigures a boolean field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder<T> Boolean<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder<T> The boolean field facade.

Type Parameters

TProp - The property type.

Boolean Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a boolean field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder Boolean(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder The boolean field facade.

Build Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Builds SDK ElicitRequestParams for form mode.

Syntax

public virtual ModelContextProtocol.Protocol.ElicitRequestParams Build()

Returns

Type: ModelContextProtocol.Protocol.ElicitRequestParams The elicitation request parameters.

Exceptions

Exception	Description
`InvalidOperationException`	Thrown when the message is blank or a field is invalid.

Choice

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder<T> Choice(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder<T>

Choice Virtual

Adds or reconfigures a single-select field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder<T> Choice<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder<T> The choice field facade.

Type Parameters

TProp - The property type.

Choice Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a single-select field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder Choice(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder The choice field facade.

Date

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> Date(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

Date Virtual

Adds or reconfigures a date field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> Date<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> The string field facade.

Type Parameters

TProp - The property type.

Date Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a string field with format date.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder Date(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

DateTime

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> DateTime(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

DateTime Virtual

Adds or reconfigures a date-time field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> DateTime<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> The string field facade.

Type Parameters

TProp - The property type.

DateTime Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a string field with format date-time.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder DateTime(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

Email

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> Email(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

Email Virtual

Adds or reconfigures an email field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> Email<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> The string field facade.

Type Parameters

TProp - The property type.

Email Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a string field with format email.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder Email(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

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

Exclude Virtual

Removes the field for property if it was seeded or added. No-ops when the property was unmappable or never added.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder<T> Exclude<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder<T> This builder.

Type Parameters

TProp - The property type.

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetOrAdd Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Gets the field with camelCase name name, adding it when missing. Reconfiguring a different kind resets kind-specific constraints.

Syntax

internal CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationField GetOrAdd(string name, CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationFieldKind kind)

Parameters

Name	Type	Description
`name`	`string`	The field identifier.
`kind`	`CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationFieldKind`	The field kind.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationField The field.

Exceptions

Exception	Description
`ArgumentException`	Thrown when name is empty.

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

Integer

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T> Integer(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T>

Integer Virtual

Adds or reconfigures an integer field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T> Integer<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T> The number field facade.

Type Parameters

TProp - The property type.

Integer Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures an integer field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder Integer(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder The number field facade.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

MultiChoice

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder<T> MultiChoice(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder<T>

MultiChoice Virtual

Adds or reconfigures a multi-select field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder<T> MultiChoice<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder<T> The multi-choice field facade.

Type Parameters

TProp - The property type.

MultiChoice Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a multi-select field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder MultiChoice(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder The multi-choice field facade.

Number

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T> Number(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T>

Number Virtual

Adds or reconfigures a number field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T> Number<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T> The number field facade.

Type Parameters

TProp - The property type.

Number Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a floating-point field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder Number(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder The number field facade.

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

Remove Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Removes the field whose wire name matches name, if present.

Syntax

internal void Remove(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier.

String

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> String(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

String Virtual

Adds or reconfigures a string field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> String<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> The string field facade.

Type Parameters

TProp - The property type.

String Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a string field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder String(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

ToInputRequest Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Builds an InputRequest wrapping FormElicitationBuilder.Build.

Syntax

public virtual ModelContextProtocol.Protocol.InputRequest ToInputRequest()

Returns

Type: ModelContextProtocol.Protocol.InputRequest An elicitation input request for task attachment.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

Uri

Syntax

public CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> Uri(string name)

Parameters

Name	Type	Description
`name`	`string`	-

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

Uri Virtual

Adds or reconfigures a URI field for property.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> Uri<TProp>(System.Linq.Expressions.Expression<System.Func<T, TProp>> property)

Parameters

Name	Type	Description
`property`	`System.Linq.Expressions.Expression<System.Func<T, TProp>>`	A simple property access on T.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T> The string field facade.

Type Parameters

TProp - The property type.

Uri Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Adds or reconfigures a string field with format uri.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder Uri(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

CloudNimble.McpEssentials.Core.Tasks.Elicitations.IFormElicitationSource<T>
CloudNimble.McpEssentials.Core.Tasks.Elicitations.IFormElicitationSource

​Definition

​Syntax

​Summary

​Type Parameters

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Parameters

​Exceptions

​ .ctor Inherited

​Syntax

​Properties

​ Fields Inherited

​Syntax

​Property Value

​ Message Inherited

​Syntax

​Property Value

​Methods

​ Boolean

​Syntax

​Parameters

​Returns

​ Boolean Virtual

​Syntax

​Parameters

​Returns

​Type Parameters

​ Boolean Inherited Virtual

​Syntax

​Parameters

​Returns

​ Build Inherited Virtual

​Syntax

​Returns

​Exceptions

​ Choice

​Syntax

​Parameters

​Returns

​ Choice Virtual

​Syntax

​Parameters

​Returns

​Type Parameters

​ Choice Inherited Virtual

​Syntax

​Parameters

​Returns

​ Date

​Syntax

​Parameters

​Returns

​ Date Virtual

​Syntax

​Parameters

​Returns

​Type Parameters

​ Date Inherited Virtual

​Syntax

​Parameters

​Returns

​ DateTime

​Syntax

​Parameters

​Returns

​ DateTime Virtual

​Syntax

​Parameters

​Returns

​Type Parameters

​ DateTime Inherited Virtual

​Syntax

​Parameters

​Returns

​ Email

​Syntax

Definition

Syntax

Summary

Type Parameters

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Parameters

Exceptions

.ctor Inherited

Syntax

Properties

Fields Inherited

Syntax

Property Value

Message Inherited

Syntax

Property Value

Methods

Boolean

Syntax

Parameters

Returns

Boolean Virtual

Syntax

Parameters

Returns

Type Parameters

Boolean Inherited Virtual

Syntax

Parameters

Returns

Build Inherited Virtual

Syntax

Returns

Exceptions

Choice

Syntax

Parameters

Returns

Choice Virtual

Syntax

Parameters

Returns

Type Parameters

Choice Inherited Virtual

Syntax

Parameters

Returns

Date

Syntax

Parameters

Returns

Date Virtual

Syntax

Parameters

Returns

Type Parameters

Date Inherited Virtual

Syntax

Parameters

Returns

DateTime

Syntax

Parameters

Returns

DateTime Virtual

Syntax

Parameters

Returns

Type Parameters

DateTime Inherited Virtual

Syntax

Parameters

Returns

Email

Syntax