cxxmcp/api/context_8hpp_source.html

// Copyright (c) 2025 [caomengxuan666]


#pragma once


#include <optional>

#include <string>


#include "cxxmcp/cancellation.hpp"

#include "cxxmcp/protocol/completion.hpp"

#include "cxxmcp/protocol/prompt.hpp"

#include "cxxmcp/protocol/resource.hpp"

#include "cxxmcp/protocol/task.hpp"

#include "cxxmcp/protocol/tool.hpp"

#include "cxxmcp/server/peer.hpp"


namespace mcp::server {


using CancellationToken = mcp::CancellationToken;


struct ToolContext : SessionContext {

  SessionClient client() const noexcept { return session_client(*this); }


  protocol::Json arguments = protocol::Json::object();

  std::optional<protocol::TaskRequestParameters> task;

  CancellationToken cancellation;


  bool cancelled() const noexcept { return cancellation.cancelled(); }

};


struct PromptContext : SessionContext {

  SessionClient client() const noexcept { return session_client(*this); }


  protocol::Json arguments = protocol::Json::object();

  CancellationToken cancellation;


  bool cancelled() const noexcept { return cancellation.cancelled(); }

};


struct ResourceContext : SessionContext {

  SessionClient client() const noexcept { return session_client(*this); }


  std::string uri;

  protocol::Json params = protocol::Json::object();

  CancellationToken cancellation;


  bool cancelled() const noexcept { return cancellation.cancelled(); }

};


struct CompletionContext : SessionContext {

  protocol::CompleteParams params;

  CancellationToken cancellation;


  bool cancelled() const noexcept { return cancellation.cancelled(); }

};


}  // namespace mcp::server

cancellation.hpp
Cooperative cancellation primitives shared by SDK lifecycle APIs.

mcp::CancellationToken
Copyable token observed by cancellation-aware SDK operations.
Definition cancellation.hpp:104

mcp::CancellationToken::cancelled
bool cancelled() const noexcept
Returns true after the associated source has requested cancellation.
Definition cancellation.hpp:117

mcp::server::ClientPeer
Non-owning handle for the client associated with a server session.
Definition peer.hpp:46

completion.hpp
Completion request and result payloads.

prompt.hpp
Prompt discovery and rendering payloads.

mcp::protocol::Json
nlohmann::json Json
JSON value type used by all protocol DTOs.
Definition types.hpp:28

resource.hpp
Resource listing, template, subscription, and read payloads.

peer.hpp
Server-side handle for sending requests and notifications to a client peer.

mcp::server::session_client
SessionClient session_client(const SessionContext &context) noexcept
Create a SessionClient handle from a session context.
Definition peer.hpp:870

mcp::protocol::CompleteParams
Parameters for completion/complete.
Definition completion.hpp:98

mcp::server::CompletionContext
Completion request context passed to typed completion handlers.
Definition context.hpp:76

mcp::server::CompletionContext::params
protocol::CompleteParams params
Parsed completion/complete request parameters.
Definition context.hpp:78

mcp::server::CompletionContext::cancellation
CancellationToken cancellation
Cooperative cancellation token for this request.
Definition context.hpp:80

mcp::server::CompletionContext::cancelled
bool cancelled() const noexcept
Convenience check for cancellation-aware completion handlers.
Definition context.hpp:83

mcp::server::PromptContext
Invocation context passed to prompt handlers.
Definition context.hpp:46

mcp::server::PromptContext::client
SessionClient client() const noexcept
Return a non-owning peer handle for this invocation's client.
Definition context.hpp:48

mcp::server::PromptContext::cancelled
bool cancelled() const noexcept
Convenience check for cancellation-aware handlers.
Definition context.hpp:56

mcp::server::PromptContext::arguments
protocol::Json arguments
JSON arguments supplied with the prompt request.
Definition context.hpp:51

mcp::server::PromptContext::cancellation
CancellationToken cancellation
Cooperative cancellation token for this request.
Definition context.hpp:53

mcp::server::ResourceContext
Invocation context passed to resource read handlers.
Definition context.hpp:60

mcp::server::ResourceContext::cancellation
CancellationToken cancellation
Cooperative cancellation token for this request.
Definition context.hpp:69

mcp::server::ResourceContext::uri
std::string uri
Requested resource URI.
Definition context.hpp:65

mcp::server::ResourceContext::params
protocol::Json params
Raw resource read parameters supplied by the client.
Definition context.hpp:67

mcp::server::ResourceContext::cancelled
bool cancelled() const noexcept
Convenience check for cancellation-aware handlers.
Definition context.hpp:72

mcp::server::ResourceContext::client
SessionClient client() const noexcept
Return a non-owning peer handle for this invocation's client.
Definition context.hpp:62

mcp::server::SessionContext
Per-message connection metadata supplied to server handlers.
Definition transport.hpp:42

mcp::server::ToolContext
Invocation context passed to tool handlers.
Definition context.hpp:30

mcp::server::ToolContext::arguments
protocol::Json arguments
JSON arguments supplied with the tool call.
Definition context.hpp:35

mcp::server::ToolContext::cancelled
bool cancelled() const noexcept
Convenience check for cancellation-aware handlers.
Definition context.hpp:42

mcp::server::ToolContext::client
SessionClient client() const noexcept
Return a non-owning peer handle for this invocation's client.
Definition context.hpp:32

mcp::server::ToolContext::task
std::optional< protocol::TaskRequestParameters > task
Optional task request metadata supplied with the tool call.
Definition context.hpp:37

mcp::server::ToolContext::cancellation
CancellationToken cancellation
Cooperative cancellation token for task-aware executions.
Definition context.hpp:39

task.hpp
Asynchronous task status and task-management payloads.

tool.hpp
Tool definition, call, and result payloads.