mcp::server::App::Builder Class Reference

Higher-level server builder with callable adapters. More...

#include <authoring.hpp>

Public Member Functions
Builder &	name (std::string value)
	Sets the advertised server name.
Builder &	version (std::string value)
	Sets the advertised server version.
Builder &	instructions (std::string value)
	Sets the advertised server instructions.
Builder &	stdio ()
	Adds a stdio server transport.
Builder &	transport (std::unique_ptr< Transport > value)
	Adds a caller-supplied transport.
Builder &	tasks (TaskOperationProcessorOptions options={})
	Enables server-side task processing for task-aware tools.
Builder &	schema_validator (std::shared_ptr< const JsonSchemaValidator > validator)
	Installs an optional JSON Schema validator.
template<class Args , class Result , class Handler >
Builder &	tool (std::string name, Handler handler)
	Registers a tool using a typed argument adapter.
template<class Args , class Result , class Handler >
Builder &	tool (protocol::ToolDefinition definition, Handler handler)
	Registers a typed callable using an explicit tool definition.
template<class Args , class Result , class Handler >
Builder &	tool (TypedToolRegistration< Args, Result, Handler > registration)
	Registers a typed tool registration built by mcp::server::tool().
Builder &	tool (protocol::ToolDefinition definition, ToolHandler handler)
	Registers a fully described tool and low-level handler.
template<class Args , class Handler >
Builder &	prompt (std::string name, Handler handler)
	Registers a prompt using a callable adapter.
template<class Handler >
Builder &	prompt (std::string name, Handler handler)
Builder &	prompt (protocol::Prompt prompt, PromptHandler handler)
	Registers a fully described prompt and low-level handler.
template<class Args , class Handler >
Builder &	resource (std::string name, Handler handler)
	Registers a resource using a callable adapter.
template<class Handler >
Builder &	resource (std::string name, Handler handler)
Builder &	resource (protocol::Resource resource, ResourceReadHandler handler)
	Registers a fully described resource and low-level read handler.
template<class Handler >
Builder &	resource_template (std::string name, Handler handler)
	Registers a resource template using a callable adapter.
Builder &	resource_template (protocol::ResourceTemplate resource_template)
	Registers a fully described resource template.
template<class Handler >
Builder &	completion (Handler handler)
	Registers a completion request handler adapter.
template<class Handler >
Builder &	sampling (Handler handler)
	Registers a sampling request handler adapter.
template<class Handler >
Builder &	logging (Handler handler)
	Registers a logging notification handler adapter.
template<class Handler >
Builder &	raw_request (Handler handler)
	Registers a raw request hook adapter.
core::Result< std::unique_ptr< Server > >	build ()
	Builds the configured server.
int	run ()
	Builds, starts, and runs the configured server application.
template<class Args , class Result , class Handler >
App::Builder &	tool (std::string name, Handler handler)
template<class Args , class Result , class Handler >
App::Builder &	tool (protocol::ToolDefinition definition, Handler handler)
template<class Args , class Result , class Handler >
App::Builder &	tool (TypedToolRegistration< Args, Result, Handler > registration)
template<class Args , class Handler >
App::Builder &	prompt (std::string name, Handler handler)
template<class Handler >
App::Builder &	prompt (std::string name, Handler handler)
template<class Args , class Handler >
App::Builder &	resource (std::string name, Handler handler)
template<class Handler >
App::Builder &	resource (std::string name, Handler handler)
template<class Handler >
App::Builder &	resource_template (std::string name, Handler handler)
template<class Handler >
App::Builder &	completion (Handler handler)
template<class Handler >
App::Builder &	sampling (Handler handler)
template<class Handler >
App::Builder &	logging (Handler handler)
template<class Handler >
App::Builder &	raw_request (Handler handler)

Detailed Description

Higher-level server builder with callable adapters.

Member Function Documentation

prompt()

template<class Args , class Handler >

Builder & mcp::server::App::Builder::prompt	(	std::string	name,
		Handler	handler
	)

Registers a prompt using a callable adapter.

Parameters

name	Prompt name advertised to clients.
handler	Callable accepting Json, string, PromptContext, one of the Json/string plus PromptContext combinations, or no argument. Returns prompt text/result or core::Result of either. CancellationToken may be accepted directly with Json/string where cooperative cancellation is useful.

raw_request()

template<class Handler >

Builder & mcp::server::App::Builder::raw_request

(

Handler

handler

)

Registers a raw request hook adapter.

Note

A handler returning std::optional<JsonRpcResponse> or JsonRpcResponse controls dispatch; a void-returning handler only observes the request.

resource()

template<class Args , class Handler >

Builder & mcp::server::App::Builder::resource	(	std::string	name,
		Handler	handler
	)

Registers a resource using a callable adapter.

Parameters

name	Resource URI and default display name.
handler	Callable accepting Json params, requested URI string, ResourceContext, one of the Json/string plus ResourceContext combinations, or no argument. Returns resource text/contents/result, protocol::Resource metadata, or core::Result of these. CancellationToken may be accepted directly with Json/string where cooperative cancellation is useful.

resource_template()

template<class Handler >

Builder & mcp::server::App::Builder::resource_template	(	std::string	name,
		Handler	handler
	)

Registers a resource template using a callable adapter.

Parameters

name	Default resource-template name and URI template when the handler does not fill those fields.
handler	Callable returning a ResourceTemplate or core::Result<ResourceTemplate>.

Exceptions

std::runtime_error

if a Result-returning handler fails during registration.

tool()

template<class Args , class Result , class Handler >

Builder & mcp::server::App::Builder::tool	(	std::string	name,
		Handler	handler
	)

Registers a tool using a typed argument adapter.

Template Parameters

Args	Type decoded from the JSON arguments object.
Result	Expected handler result type.
Handler	Callable invoked with Args.

Parameters

name	Tool name advertised to clients.
handler	Callable returning Result or core::Result<Result>.

Returns

Reference to this builder for chaining.

Note

std::exception-derived errors thrown by argument decoding are caught and converted to InvalidParams results when the tool is invoked.

transport()

Builder & mcp::server::App::Builder::transport

(

std::unique_ptr< Transport >

value

)

Adds a caller-supplied transport.

Parameters

value

Transport owned by the built server.

---

The documentation for this class was generated from the following file:

• sdk/server/include/cxxmcp/server/authoring.hpp