Class Prompt

Namespace

ModelContextProtocol.Protocol

Assembly

ModelContextProtocol.Core.dll

Represents a prompt that the server offers.

public class Prompt

Inheritance

object

Prompt

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

See the schema for details.

Properties

Arguments

Gets or sets a list of arguments that this prompt accepts for templating and customization.

[JsonPropertyName("arguments")]
public List<PromptArgument>? Arguments { get; set; }

Property Value

List<PromptArgument>

Remarks

This list defines the arguments that can be provided when requesting the prompt. Each argument specifies metadata like name, description, and whether it's required.

When a client makes a PromptsGet request, it can provide values for these arguments which will be substituted into the prompt template or otherwise used to render the prompt.

Description

Gets or sets an optional description of what this prompt provides.

[JsonPropertyName("description")]
public string? Description { get; set; }

Property Value

string

Remarks

This description helps developers understand the purpose and use cases for the prompt. It should explain what the prompt is designed to accomplish and any important context.

The description is typically used in documentation, UI displays, and for providing context to client applications that may need to choose between multiple available prompts.

Name

Gets or sets the name of the prompt.

[JsonPropertyName("name")]
public string Name { get; set; }

Property Value

string