Package dev.tachyonmcp.core.server

Interface ServerBuilder

public interface ServerBuilder

Configures and builds a TachyonServer; call TachyonServer.start() to bind its transport.

Method Summary

Modifier and Type	Method	Description
TachyonServer	build()	Constructs the configured server without starting its transport, then executes the configured feature-registration callbacks.
ServerConfig	buildConfig()	Builds the immutable server configuration.
ServerBuilder	capabilities(Consumer<CapabilitiesConfig.Builder> configurer)	Configures advertised MCP capabilities.
ServerBuilder	executor(ExecutorService executor)	Sets a caller-owned thread-per-task executor.
ServerBuilder	extension(ServerExtension extension)	Registers a server extension.
ServerBuilder	host(String host)	Sets the bind host.
ServerBuilder	info(Consumer<ServerIdentity.Builder> configurer)	Configures server identity.
ServerBuilder	json(Consumer<JsonConfig.Builder> configurer)	Configures JSON serialization and validation.
ServerBuilder	monitoring(Consumer<MonitoringConfig.Builder> configurer)	Configures monitoring.
ServerBuilder	name(String name)	Sets the server name.
ServerBuilder	network(Consumer<NetworkConfig.Builder> configurer)	Configures the network transport.
ServerBuilder	pipelineCustomizer(@Nullable Consumer<io.netty.channel.ChannelPipeline> customizer)	Customizes each Netty channel pipeline.
ServerBuilder	port(int port)	Sets the listen port.
ServerBuilder	runtime(Consumer<RuntimeConfig.Builder> configurer)	Configures handler execution.
ServerBuilder	session(Consumer<SessionConfig.Builder> configurer)	Configures session lifecycle and persistence.
ServerBuilder	threadFactory(ThreadFactory threadFactory)	Sets the thread factory used by the server-owned thread-per-task executor.
ServerBuilder	version(String version)	Sets the server version.
ServerBuilder	withCompletions(Consumer<Completions> registrar)	Registers completions through the server's completion façade at the end of build().
ServerBuilder	withPrompts(Consumer<Prompts> registrar)	Registers prompts through the server's prompt façade at the end of build().
ServerBuilder	withResources(Consumer<Resources> registrar)	Registers resources through the server's resource façade at the end of build().
ServerBuilder	withTools(Consumer<Tools> registrar)	Registers tools through the server's tool façade at the end of build().

Method Details

info

ServerBuilder info(Consumer<ServerIdentity.Builder> configurer)

Configures server identity.

capabilities

ServerBuilder capabilities(Consumer<CapabilitiesConfig.Builder> configurer)

Configures advertised MCP capabilities.

session

ServerBuilder session(Consumer<SessionConfig.Builder> configurer)

Configures session lifecycle and persistence.

network

ServerBuilder network(Consumer<NetworkConfig.Builder> configurer)

Configures the network transport.

runtime

ServerBuilder runtime(Consumer<RuntimeConfig.Builder> configurer)

Configures handler execution.

monitoring

ServerBuilder monitoring(Consumer<MonitoringConfig.Builder> configurer)

Configures monitoring.

json

ServerBuilder json(Consumer<JsonConfig.Builder> configurer)

Configures JSON serialization and validation.

name

ServerBuilder name(String name)

Sets the server name.

port

ServerBuilder port(int port)

Sets the listen port.

version

ServerBuilder version(String version)

Sets the server version.

host

ServerBuilder host(String host)

Sets the bind host.

withTools

ServerBuilder withTools(Consumer<Tools> registrar)

Registers tools through the server's tool façade at the end of build().

withResources

ServerBuilder withResources(Consumer<Resources> registrar)

Registers resources through the server's resource façade at the end of build().

withPrompts

ServerBuilder withPrompts(Consumer<Prompts> registrar)

Registers prompts through the server's prompt façade at the end of build().

withCompletions

ServerBuilder withCompletions(Consumer<Completions> registrar)

Registers completions through the server's completion façade at the end of build().

extension

ServerBuilder extension(ServerExtension extension)

Registers a server extension.

executor

ServerBuilder executor(ExecutorService executor)

Sets a caller-owned thread-per-task executor. The caller must close the executor after the server is closed. build() rejects bounded executors with an IllegalArgumentException.

threadFactory

ServerBuilder threadFactory(ThreadFactory threadFactory)

Sets the thread factory used by the server-owned thread-per-task executor.

pipelineCustomizer

@ExperimentalApi
ServerBuilder pipelineCustomizer(@Nullable Consumer<io.netty.channel.ChannelPipeline> customizer)

Customizes each Netty channel pipeline.

build

TachyonServer build()

Constructs the configured server without starting its transport, then executes the configured feature-registration callbacks.

Throws:

IllegalArgumentException - if the configured executor is bounded

buildConfig

ServerConfig buildConfig()

Builds the immutable server configuration.