cxxmcp 1.1.6
C++ MCP SDK
Loading...
Searching...
No Matches
completion.hpp File Reference

Completion request and result payloads. More...

#include <cstddef>
#include <cstdint>
#include <limits>
#include <map>
#include <optional>
#include <string>
#include <utility>
#include <vector>
#include "cxxmcp/core/result.hpp"
#include "cxxmcp/protocol/reflect.hpp"
#include "cxxmcp/protocol/types.hpp"

Go to the source code of this file.

Classes

struct  mcp::protocol::CompletionReference
 Reference to the prompt or resource template being completed. More...
 
struct  mcp::protocol::CompletionArgument
 Argument value being completed. More...
 
struct  mcp::protocol::Reflect< CompletionArgument >
 
struct  mcp::protocol::CompletionContext
 Contextual argument values used to improve completions. More...
 
struct  mcp::protocol::Reflect< CompletionContext >
 
struct  mcp::protocol::CompleteParams
 Parameters for completion/complete. More...
 
struct  mcp::protocol::CompletionResult
 Completion candidates returned by the server. More...
 
struct  mcp::protocol::CompleteResult
 Result object for completion/complete. More...
 

Functions

CompletionReference mcp::protocol::prompt_completion_reference (std::string name)
 Builds a prompt completion reference.
 
CompletionReference mcp::protocol::resource_completion_reference (std::string uri)
 Builds a resource completion reference.
 
core::Error mcp::protocol::completion_json_error (std::string message)
 Builds an InvalidRequest error for completion JSON validation failures.
 
Json mcp::protocol::completion_reference_to_json (const CompletionReference &ref)
 Serializes a completion reference.
 
core::Result< CompletionReferencemcp::protocol::completion_reference_from_json (const Json &json)
 Parses a completion reference.
 
Json mcp::protocol::completion_argument_to_json (const CompletionArgument &argument)
 Serializes a completion argument.
 
core::Result< CompletionArgumentmcp::protocol::completion_argument_from_json (const Json &json)
 Parses a completion argument.
 
Json mcp::protocol::completion_context_to_json (const CompletionContext &context)
 Serializes a CompletionContext struct to JSON.
 
core::Result< CompletionContextmcp::protocol::completion_context_from_json (const Json &json)
 Parses a CompletionContext struct from JSON.
 
Json mcp::protocol::complete_params_to_json (const CompleteParams &params)
 Serializes completion/complete params.
 
core::Result< CompleteParamsmcp::protocol::complete_params_from_json (const Json &json)
 Parses completion/complete params.
 
Json mcp::protocol::completion_result_to_json (const CompletionResult &completion)
 Serializes completion candidates.
 
core::Result< CompletionResultmcp::protocol::completion_result_from_json (const Json &json)
 Parses completion candidates.
 
Json mcp::protocol::complete_result_to_json (const CompleteResult &result)
 Serializes a completion/complete result.
 
core::Result< CompleteResultmcp::protocol::complete_result_from_json (const Json &json)
 Parses a completion/complete result.
 

Detailed Description

Completion request and result payloads.

Completion helps clients fill prompt arguments or resource-template variables by sending a completion/complete request for a referenced MCP object and one argument value prefix.

Function Documentation

◆ complete_params_from_json()

core::Result< CompleteParams > mcp::protocol::complete_params_from_json ( const Json json)
inline

Parses completion/complete params.

Returns
Parsed params or validation error.

◆ complete_result_from_json()

core::Result< CompleteResult > mcp::protocol::complete_result_from_json ( const Json json)
inline

Parses a completion/complete result.

Returns
Parsed result or validation error.

◆ completion_argument_from_json()

core::Result< CompletionArgument > mcp::protocol::completion_argument_from_json ( const Json json)
inline

Parses a completion argument.

Returns
Parsed argument or validation error.

◆ completion_reference_from_json()

core::Result< CompletionReference > mcp::protocol::completion_reference_from_json ( const Json json)
inline

Parses a completion reference.

Returns
Parsed reference or validation error.

◆ completion_result_from_json()

core::Result< CompletionResult > mcp::protocol::completion_result_from_json ( const Json json)
inline

Parses completion candidates.

Returns
Parsed completion payload or validation error.