forked from modelcontextprotocol/csharp-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGetPromptRequestParams.cs
More file actions
31 lines (28 loc) · 1.33 KB
/
GetPromptRequestParams.cs
File metadata and controls
31 lines (28 loc) · 1.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
using System.Text.Json;
using System.Text.Json.Serialization;
namespace ModelContextProtocol.Protocol;
/// <summary>
/// Represents the parameters used with a <see cref="RequestMethods.PromptsGet"/> request from a client to get a prompt provided by a server.
/// </summary>
/// <remarks>
/// The server will respond with a <see cref="GetPromptResult"/> containing the resulting prompt.
/// See the <see href="https://github.com/modelcontextprotocol/specification/blob/main/schema/">schema</see> for details.
/// </remarks>
public class GetPromptRequestParams : RequestParams
{
/// <summary>
/// Gets or sets the name of the prompt.
/// </summary>
[JsonPropertyName("name")]
public required string Name { get; init; }
/// <summary>
/// Gets or sets arguments to use for templating the prompt when retrieving it from the server.
/// </summary>
/// <remarks>
/// Typically, these arguments are used to replace placeholders in prompt templates. The keys in this dictionary
/// should match the names defined in the prompt's <see cref="Prompt.Arguments"/> list. However, the server may
/// choose to use these arguments in any way it deems appropriate to generate the prompt.
/// </remarks>
[JsonPropertyName("arguments")]
public IReadOnlyDictionary<string, JsonElement>? Arguments { get; init; }
}