prompt.hpp File Reference

Prompt discovery and rendering payloads. More...

#include <optional>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "cxxmcp/core/result.hpp"
#include "cxxmcp/protocol/tool.hpp"
#include "cxxmcp/protocol/types.hpp"
#include "cxxmcp/protocol/types_reflect.hpp"

Go to the source code of this file.

Classes
struct	mcp::protocol::PromptArgument
	Argument accepted by a prompt template. More...
struct	mcp::protocol::Prompt
	Prompt descriptor returned by prompts/list. More...
class	mcp::protocol::PromptBuilder
	Fluent builder for prompt descriptors. More...
struct	mcp::protocol::PromptsListResult
	Result object for prompts/list. More...
struct	mcp::protocol::PromptsGetParams
	Parameters for prompts/get. More...
struct	mcp::protocol::PromptMessage
	One rendered prompt message. More...
struct	mcp::protocol::PromptsGetResult
	Result object for prompts/get. More...

Enumerations
enum class	mcp::protocol::PromptMessageRole { User , Assistant }
	Roles allowed on a prompt message. More...

Functions
std::string_view	mcp::protocol::prompt_message_role_to_string (PromptMessageRole role)
	Converts a prompt message role to its MCP wire string.
std::optional< PromptMessageRole >	mcp::protocol::prompt_message_role_from_string (std::string_view value)
	Parses a prompt message role string.
bool	mcp::protocol::is_valid_prompt_message_role (std::string_view value)
	Checks whether a string is a valid prompt message role.
PromptBuilder	mcp::protocol::prompt_definition (std::string name)
	Creates a fluent builder for advertised MCP prompt metadata.
core::Error	mcp::protocol::prompt_json_error (std::string message)
	Builds an InvalidRequest error for prompt JSON validation failures.
Json	mcp::protocol::prompt_argument_to_json (const PromptArgument &argument)
	Serializes a prompt argument descriptor.
core::Result< PromptArgument >	mcp::protocol::prompt_argument_from_json (const Json &json)
	Parses a prompt argument descriptor.
Json	mcp::protocol::prompt_to_json (const Prompt &prompt)
	Serializes a prompt descriptor.
core::Result< Prompt >	mcp::protocol::prompt_from_json (const Json &json)
	Parses a prompt descriptor.
Json	mcp::protocol::prompts_list_result_to_json (const PromptsListResult &result)
	Serializes a prompts/list result.
core::Result< PromptsListResult >	mcp::protocol::prompts_list_result_from_json (const Json &json)
	Parses a prompts/list result.
Json	mcp::protocol::prompts_get_params_to_json (const PromptsGetParams &params)
	Serializes prompts/get params.
core::Result< PromptsGetParams >	mcp::protocol::prompts_get_params_from_json (const Json &json)
	Parses prompts/get params.
Json	mcp::protocol::prompt_message_to_json (const PromptMessage &message)
	Serializes one rendered prompt message.
core::Result< PromptMessage >	mcp::protocol::prompt_message_from_json (const Json &json)
	Parses one rendered prompt message.
Json	mcp::protocol::prompts_get_result_to_json (const PromptsGetResult &result)
	Serializes a prompts/get result.
core::Result< PromptsGetResult >	mcp::protocol::prompts_get_result_from_json (const Json &json)
	Parses a prompts/get result.

Detailed Description

Prompt discovery and rendering payloads.

Prompts are server-defined templates retrieved through prompts/get. Listing returns prompt metadata and argument definitions; getting a prompt returns concrete messages that can be supplied to a model.

Enumeration Type Documentation

PromptMessageRole

enum class mcp::protocol::PromptMessageRole

strong

Roles allowed on a prompt message.

Enumerator
User	Message from the user.
Assistant	Message from the assistant (model).

Function Documentation

prompt_argument_from_json()

core::Result< PromptArgument > mcp::protocol::prompt_argument_from_json ( const Json &  json )

inline

Parses a prompt argument descriptor.

Returns

Parsed argument or validation error.

prompt_from_json()

core::Result< Prompt > mcp::protocol::prompt_from_json ( const Json &  json )

inline

Parses a prompt descriptor.

Returns

Parsed prompt or validation error.

prompt_message_from_json()

core::Result< PromptMessage > mcp::protocol::prompt_message_from_json ( const Json &  json )

inline

Parses one rendered prompt message.

Returns

Parsed message or validation error.

prompt_message_role_from_string()

std::optional< PromptMessageRole > mcp::protocol::prompt_message_role_from_string ( std::string_view  value )

inline

Parses a prompt message role string.

Returns

Parsed role, or nullopt for unsupported strings.

prompts_get_params_from_json()

core::Result< PromptsGetParams > mcp::protocol::prompts_get_params_from_json ( const Json &  json )

inline

Parses prompts/get params.

Returns

Parsed params or validation error.

prompts_get_result_from_json()

core::Result< PromptsGetResult > mcp::protocol::prompts_get_result_from_json ( const Json &  json )

inline

Parses a prompts/get result.

Returns

Parsed result or validation error.

prompts_list_result_from_json()

core::Result< PromptsListResult > mcp::protocol::prompts_list_result_from_json ( const Json &  json )

inline

Parses a prompts/list result.

Returns

Parsed result or validation error.