mcp::protocol::ElicitationSchema Struct Reference

Object schema requested from a user in form elicitation. More...

#include <elicitation.hpp>

Classes
class	Builder
	Fluent builder for valid elicitation object schemas. More...

Static Public Member Functions
static StringSchema	new_string (std::optional< std::string > title=std::nullopt, std::optional< std::string > description=std::nullopt, std::optional< std::string > format=std::nullopt, std::optional< std::int64_t > min_length=std::nullopt, std::optional< std::int64_t > max_length=std::nullopt, std::optional< std::string > default_value=std::nullopt)
	Creates a new string primitive schema.
static NumberSchema	new_number (std::optional< std::string > title=std::nullopt, std::optional< std::string > description=std::nullopt, std::optional< double > minimum=std::nullopt, std::optional< double > maximum=std::nullopt, std::optional< double > default_value=std::nullopt)
	Creates a new number primitive schema.
static IntegerSchema	new_integer (std::optional< std::string > title=std::nullopt, std::optional< std::string > description=std::nullopt, std::optional< std::int64_t > minimum=std::nullopt, std::optional< std::int64_t > maximum=std::nullopt, std::optional< std::int64_t > default_value=std::nullopt)
	Creates a new integer primitive schema.
static BooleanSchema	new_boolean (std::optional< std::string > title=std::nullopt, std::optional< std::string > description=std::nullopt, std::optional< bool > default_value=std::nullopt)
	Creates a new boolean primitive schema.
static EnumSchema	new_enum (std::vector< std::string > values, std::optional< std::string > title=std::nullopt, std::optional< std::string > description=std::nullopt, std::optional< std::string > default_value=std::nullopt)
	Creates a new enum primitive schema.
static Builder	builder ()
	Creates a builder for an elicitation object schema.

Public Attributes
std::optional< std::string >	title
	Optional form title.
std::optional< std::string >	description
	Optional form description.
std::map< std::string, PrimitiveSchema >	properties
	Properties keyed by field name.
std::vector< std::string >	required
	Names of required properties.
Json	extensions = Json::object()
	Unknown JSON members preserved for forward-compatible round trips.

Detailed Description

Object schema requested from a user in form elicitation.

---

The documentation for this struct was generated from the following file:

• sdk/protocol/include/cxxmcp/protocol/elicitation.hpp