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

Client root discovery payloads. More...

#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::Root
 One client root entry. More...
 
struct  mcp::protocol::Reflect< Root >
 
struct  mcp::protocol::RootsListResult
 Result object for roots/list. More...
 

Functions

core::Error mcp::protocol::roots_json_error (std::string message)
 Builds an InvalidRequest error for roots JSON validation failures.
 
Json mcp::protocol::root_to_json (const Root &root)
 Serializes a root entry.
 
core::Result< Rootmcp::protocol::root_from_json (const Json &json)
 Parses a root entry.
 
Json mcp::protocol::roots_list_result_to_json (const RootsListResult &result)
 Serializes a roots/list result.
 
core::Result< RootsListResultmcp::protocol::roots_list_result_from_json (const Json &json)
 Parses a roots/list result.
 

Detailed Description

Client root discovery payloads.

Roots describe filesystem or workspace anchors that a client makes available to a server. Servers request them with roots/list, and clients can notify changes when the roots capability advertises list change support.

Function Documentation

◆ root_from_json()

core::Result< Root > mcp::protocol::root_from_json ( const Json json)
inline

Parses a root entry.

Returns
Parsed root or validation error.

◆ roots_list_result_from_json()

core::Result< RootsListResult > mcp::protocol::roots_list_result_from_json ( const Json json)
inline

Parses a roots/list result.

Returns
Parsed result or validation error.