serialization.hpp

Go to the documentation of this file.

// Copyright (c) 2025 [caomengxuan666]
 
#pragma once
 
 
#include <array>
#include <optional>
#include <string>
#include <string_view>
#include <variant>
 
#include "cxxmcp/core/result.hpp"
#include "cxxmcp/core/string_constant.hpp"
#include "cxxmcp/protocol/types.hpp"
 
namespace mcp::protocol {
 
#define CXXMCP_PROTOCOL_STRING_CONSTANT(name, value) \
  inline constexpr core::StringConstant name { value }
 
CXXMCP_PROTOCOL_STRING_CONSTANT(JsonRpcVersion, "2.0");
CXXMCP_PROTOCOL_STRING_CONSTANT(McpProtocolVersion2026_07_28, "2026-07-28");
CXXMCP_PROTOCOL_STRING_CONSTANT(McpProtocolVersion2025_11_25, "2025-11-25");
CXXMCP_PROTOCOL_STRING_CONSTANT(McpProtocolVersion2025_06_18, "2025-06-18");
CXXMCP_PROTOCOL_STRING_CONSTANT(McpProtocolVersion2025_03_26, "2025-03-26");
CXXMCP_PROTOCOL_STRING_CONSTANT(McpProtocolVersion2024_11_05, "2024-11-05");
inline constexpr core::StringConstant McpProtocolVersion{"2025-11-25"};
inline constexpr std::array<const char*, 6> McpSupportedProtocolVersions{
    "2024-11-05", "2025-03-26", "2025-06-18",
    "2025-11-25", "2026-07-28", "DRAFT-2026-v1"};
 
inline bool is_supported_protocol_version(std::string_view version) noexcept {
  for (const auto* supported : McpSupportedProtocolVersions) {
    if (version == std::string_view(supported)) {
      return true;
    }
  }
  return false;
}
 
inline std::optional<std::string_view> negotiate_protocol_version(
    std::string_view requested) noexcept {
  for (const auto* supported : McpSupportedProtocolVersions) {
    if (requested == std::string_view(supported)) {
      return std::string_view(supported);
    }
  }
  return std::nullopt;
}
 
CXXMCP_PROTOCOL_STRING_CONSTANT(InitializeMethod, "initialize");
CXXMCP_PROTOCOL_STRING_CONSTANT(InitializedMethod, "notifications/initialized");
CXXMCP_PROTOCOL_STRING_CONSTANT(PingMethod, "ping");
CXXMCP_PROTOCOL_STRING_CONSTANT(ServerDiscoverMethod, "server/discover");
CXXMCP_PROTOCOL_STRING_CONSTANT(PromptsListMethod, "prompts/list");
CXXMCP_PROTOCOL_STRING_CONSTANT(PromptsGetMethod, "prompts/get");
CXXMCP_PROTOCOL_STRING_CONSTANT(ResourcesListMethod, "resources/list");
CXXMCP_PROTOCOL_STRING_CONSTANT(ResourcesReadMethod, "resources/read");
CXXMCP_PROTOCOL_STRING_CONSTANT(ResourcesTemplatesListMethod,
                                "resources/templates/list");
CXXMCP_PROTOCOL_STRING_CONSTANT(ResourcesSubscribeMethod,
                                "resources/subscribe");
CXXMCP_PROTOCOL_STRING_CONSTANT(ResourcesUnsubscribeMethod,
                                "resources/unsubscribe");
CXXMCP_PROTOCOL_STRING_CONSTANT(ToolsListMethod, "tools/list");
CXXMCP_PROTOCOL_STRING_CONSTANT(ToolsGetMethod, "tools/get");
CXXMCP_PROTOCOL_STRING_CONSTANT(ToolsCallMethod, "tools/call");
CXXMCP_PROTOCOL_STRING_CONSTANT(CompletionCompleteMethod,
                                "completion/complete");
CXXMCP_PROTOCOL_STRING_CONSTANT(LoggingSetLevelMethod, "logging/setLevel");
CXXMCP_PROTOCOL_STRING_CONSTANT(SamplingCreateMessageMethod,
                                "sampling/createMessage");
CXXMCP_PROTOCOL_STRING_CONSTANT(ElicitationCreateMethod, "elicitation/create");
CXXMCP_PROTOCOL_STRING_CONSTANT(ElicitationCompleteNotificationMethod,
                                "notifications/elicitation/complete");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksListMethod, "tasks/list");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksGetMethod, "tasks/get");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksCancelMethod, "tasks/cancel");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksResultMethod, "tasks/result");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksUpdateMethod, "tasks/update");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksCreateMethod, "tasks/create");
CXXMCP_PROTOCOL_STRING_CONSTANT(SubscriptionsListenMethod,
                                "subscriptions/listen");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksExtensionId,
                                "io.modelcontextprotocol/tasks");
CXXMCP_PROTOCOL_STRING_CONSTANT(SkillsExtensionId,
                                "io.modelcontextprotocol/skills");
CXXMCP_PROTOCOL_STRING_CONSTANT(TasksStatusNotificationMethod,
                                "notifications/tasks/status");
CXXMCP_PROTOCOL_STRING_CONSTANT(SubscriptionsAcknowledgedNotificationMethod,
                                "notifications/subscriptions/acknowledged");
CXXMCP_PROTOCOL_STRING_CONSTANT(RootsListMethod, "roots/list");
CXXMCP_PROTOCOL_STRING_CONSTANT(CancelledNotificationMethod,
                                "notifications/cancelled");
CXXMCP_PROTOCOL_STRING_CONSTANT(ProgressNotificationMethod,
                                "notifications/progress");
CXXMCP_PROTOCOL_STRING_CONSTANT(RootsListChangedNotificationMethod,
                                "notifications/roots/list_changed");
CXXMCP_PROTOCOL_STRING_CONSTANT(ResourcesListChangedNotificationMethod,
                                "notifications/resources/list_changed");
CXXMCP_PROTOCOL_STRING_CONSTANT(ResourcesUpdatedNotificationMethod,
                                "notifications/resources/updated");
CXXMCP_PROTOCOL_STRING_CONSTANT(ToolsListChangedNotificationMethod,
                                "notifications/tools/list_changed");
CXXMCP_PROTOCOL_STRING_CONSTANT(PromptsListChangedNotificationMethod,
                                "notifications/prompts/list_changed");
CXXMCP_PROTOCOL_STRING_CONSTANT(LoggingMessageNotificationMethod,
                                "notifications/message");
 
#undef CXXMCP_PROTOCOL_STRING_CONSTANT
 
ErrorObject make_error(int code, std::string message,
                       std::optional<Json> data = std::nullopt);
 
ErrorObject make_error(ErrorCode code, std::string message,
                       std::optional<Json> data = std::nullopt);
 
JsonRpcResponse make_response(RequestId id, Json result);
 
JsonRpcResponse make_error_response(std::optional<RequestId> id,
                                    ErrorObject error);
 
JsonRpcRequest make_request(std::string method, RequestId id,
                            Json params = Json::object());
 
JsonRpcNotification make_notification(std::string method,
                                      Json params = Json::object());
 
JsonRpcRequest make_initialize_request(RequestId id,
                                       Json params = Json::object());
 
JsonRpcNotification make_initialized_notification(Json params = Json::object());
 
JsonRpcRequest make_ping_request(RequestId id, Json params = Json::object());
 
core::Result<JsonRpcMessage> parse_message(std::string_view text);
 
core::Result<std::string> serialize_message(const JsonRpcMessage& message);
 
core::Result<JsonRpcRequest> parse_request(std::string_view text);
core::Result<JsonRpcResponse> parse_response(std::string_view text);
core::Result<JsonRpcNotification> parse_notification(std::string_view text);
core::Result<std::string> serialize_request(const JsonRpcRequest& request);
core::Result<std::string> serialize_response(const JsonRpcResponse& response);
core::Result<std::string> serialize_notification(
    const JsonRpcNotification& notification);
core::Result<std::string> serialize_error(
    const ErrorObject& error, std::optional<RequestId> id = std::nullopt);
 
}  // namespace mcp::protocol