McpElicitFormAttribute

Definition

Assembly: CloudNimble.McpEssentials.Core.dll Namespace: CloudNimble.McpEssentials.Core.Tasks.Elicitations Inheritance: System.Attribute

Syntax

CloudNimble.McpEssentials.Core.Tasks.Elicitations.McpElicitFormAttribute

Summary

Marks a tool so MCP elicits a named form before the member runs. WithTasksPlus keeps the call on tools/call Multi Round-Trip Requests (Synchronous).

Remarks

Pass the same name to AddFormElicitation and RequireForm. Class-level usage applies to every [McpServerTool] method on the type. When both this attribute and McpElicitUrlAttribute are present, the form wins.

Examples

[McpServerTool(Name = "ShipOrder")]
[McpElicitForm("ship")]
public static string ShipOrder(RequestContext&lt;CallToolRequestParams&gt; context)
{
    var result = context.RequireForm("ship");
    if (!result.IsAccepted)
    {
        return "Shipping cancelled.";
    }

    return $"Shipped as {result.Content!["trackingNumber"].GetString()}.";
}

Constructors

.ctor

Marks the member as eliciting the named form.

Syntax

public McpElicitFormAttribute(string name)

Parameters

Name	Type	Description
`name`	`string`	The name passed to `AddFormElicitation` and `RequireForm`.

Exceptions

Exception	Description
`ArgumentException`	Thrown when name is empty.

Properties

Name

Gets the keyed form name.

Syntax

public string Name { get; }

Property Value

Type: string

Getting Started

Guides

API Reference

McpElicitFormAttribute

Definition

Syntax

Summary

Remarks

Examples

Constructors

.ctor

Syntax

Parameters

Exceptions

Properties

Name

Syntax

Property Value

​Definition

​Syntax

​Summary

​Remarks

​Examples

​Constructors

​ .ctor

​Syntax

​Parameters

​Exceptions

​Properties

​ Name

​Syntax

​Property Value

Definition

Syntax

Summary

Remarks

Examples

Constructors

.ctor

Syntax

Parameters

Exceptions

Properties

Name

Syntax

Property Value