Class McpServer.Builder

java.lang.Object

com.soklet.McpServer.Builder

Enclosing interface:

McpServer

@NotThreadSafe
public static final class McpServer.Builder
extends Object

Builder for McpServer instances.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull McpServer	build()	Builds the MCP server.
@NonNull McpServer.Builder	concurrentConnectionLimit(@Nullable Integer concurrentConnectionLimit)	Sets the concurrent connection limit for the MCP server.
@NonNull McpServer.Builder	connectionQueueCapacity(@Nullable Integer connectionQueueCapacity)	Sets the outbound queue capacity for live MCP streams.
@NonNull McpServer.Builder	corsAuthorizer(@Nullable McpCorsAuthorizer corsAuthorizer)	Sets the MCP CORS authorizer.
@NonNull McpServer.Builder	handlerResolver(@Nullable McpHandlerResolver handlerResolver)	Sets the handler resolver.
@NonNull McpServer.Builder	heartbeatInterval(@Nullable Duration heartbeatInterval)	Sets the heartbeat interval for long-lived MCP event streams.
@NonNull McpServer.Builder	host(@Nullable String host)	Sets the host to bind, or null to use the server default.
@NonNull McpServer.Builder	maximumHeaderCount(@Nullable Integer maximumHeaderCount)	Sets the maximum number of HTTP header fields accepted in one MCP request.
@NonNull McpServer.Builder	maximumHeadersSizeInBytes(@Nullable Integer maximumHeadersSizeInBytes)	Sets the maximum accepted MCP HTTP header-section size in bytes.
@NonNull McpServer.Builder	maximumRequestSizeInBytes(@Nullable Integer maximumRequestSizeInBytes)	Sets the maximum accepted MCP request size in bytes.
@NonNull McpServer.Builder	maximumRequestTargetLengthInBytes(@Nullable Integer maximumRequestTargetLengthInBytes)	Sets the maximum MCP HTTP request-target length accepted in bytes.
@NonNull McpServer.Builder	port(@NonNull Integer port)	Sets the port to bind.
@NonNull McpServer.Builder	requestAdmissionPolicy(@Nullable McpRequestAdmissionPolicy requestAdmissionPolicy)	Sets the request admission policy.
@NonNull McpServer.Builder	requestBodyTimeout(@Nullable Duration requestBodyTimeout)	Sets the maximum duration for reading the MCP HTTP request body after the request line and headers have been received.
@NonNull McpServer.Builder	requestHandlerConcurrency(@Nullable Integer requestHandlerConcurrency)	Sets the handler concurrency level for MCP JSON-RPC request handling.
@NonNull McpServer.Builder	requestHandlerExecutorServiceSupplier(@Nullable Supplier<ExecutorService> requestHandlerExecutorServiceSupplier)	Sets the supplier used to create the handler executor service.
@NonNull McpServer.Builder	requestHandlerQueueCapacity(@Nullable Integer requestHandlerQueueCapacity)	Sets the handler queue capacity for MCP JSON-RPC request handling.
@NonNull McpServer.Builder	requestHandlerTimeout(@Nullable Duration requestHandlerTimeout)	Sets the timeout for MCP handler execution, including framework-managed McpEndpoint.initialize(McpInitializationContext, McpSessionContext) calls.
@NonNull McpServer.Builder	requestHeaderTimeout(@Nullable Duration requestHeaderTimeout)	Sets the maximum duration for reading the MCP HTTP request line and headers.
@NonNull McpServer.Builder	requestInterceptor(@Nullable McpRequestInterceptor requestInterceptor)	Sets the request interceptor.
@NonNull McpServer.Builder	requestReadBufferSizeInBytes(@Nullable Integer requestReadBufferSizeInBytes)	Sets the read buffer size used while reading MCP requests.
@NonNull McpServer.Builder	responseMarshaler(@Nullable McpResponseMarshaler responseMarshaler)	Sets the response marshaler used for tool structured content.
@NonNull McpServer.Builder	sessionStore(@Nullable McpSessionStore sessionStore)	Sets the session store.
@NonNull McpServer.Builder	shutdownTimeout(@Nullable Duration shutdownTimeout)	Sets the shutdown timeout.
@NonNull McpServer.Builder	writeTimeout(@Nullable Duration writeTimeout)	Sets the transport write timeout for established MCP event streams.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

port

public @NonNull McpServer.Builder port(@NonNull Integer port)

Sets the port to bind.

Parameters:

port - the port

Returns:

this builder

host

public @NonNull McpServer.Builder host(@Nullable String host)

Sets the host to bind, or null to use the server default.

Parameters:

host - the host to bind

Returns:

this builder

handlerResolver

public @NonNull McpServer.Builder handlerResolver(@Nullable McpHandlerResolver handlerResolver)

Sets the handler resolver.

Parameters:

handlerResolver - the handler resolver

Returns:

this builder

requestAdmissionPolicy

public @NonNull McpServer.Builder requestAdmissionPolicy(@Nullable McpRequestAdmissionPolicy requestAdmissionPolicy)

Sets the request admission policy.

Parameters:

requestAdmissionPolicy - the admission policy

Returns:

this builder

requestInterceptor

public @NonNull McpServer.Builder requestInterceptor(@Nullable McpRequestInterceptor requestInterceptor)

Sets the request interceptor.

Parameters:

requestInterceptor - the request interceptor

Returns:

this builder

responseMarshaler

public @NonNull McpServer.Builder responseMarshaler(@Nullable McpResponseMarshaler responseMarshaler)

Sets the response marshaler used for tool structured content.

Parameters:

responseMarshaler - the response marshaler

Returns:

this builder

corsAuthorizer

public @NonNull McpServer.Builder corsAuthorizer(@Nullable McpCorsAuthorizer corsAuthorizer)

Sets the MCP CORS authorizer.

Parameters:

corsAuthorizer - the CORS authorizer

Returns:

this builder

sessionStore

public @NonNull McpServer.Builder sessionStore(@Nullable McpSessionStore sessionStore)

Sets the session store.

Parameters:

sessionStore - the session store

Returns:

this builder

requestHeaderTimeout

public @NonNull McpServer.Builder requestHeaderTimeout(@Nullable Duration requestHeaderTimeout)

Sets the maximum duration for reading the MCP HTTP request line and headers.

If this value is not specified, Soklet uses the server default.

Parameters:

requestHeaderTimeout - the request header timeout, or null for the default

Returns:

this builder

requestBodyTimeout

public @NonNull McpServer.Builder requestBodyTimeout(@Nullable Duration requestBodyTimeout)

Sets the maximum duration for reading the MCP HTTP request body after the request line and headers have been received.

If this value is not specified, Soklet uses the server default.

Parameters:

requestBodyTimeout - the request body timeout, or null for the default

Returns:

this builder

requestHandlerTimeout

public @NonNull McpServer.Builder requestHandlerTimeout(@Nullable Duration requestHandlerTimeout)

Sets the timeout for MCP handler execution, including framework-managed McpEndpoint.initialize(McpInitializationContext, McpSessionContext) calls.

Parameters:

requestHandlerTimeout - the handler timeout

Returns:

this builder

requestHandlerConcurrency

public @NonNull McpServer.Builder requestHandlerConcurrency(@Nullable Integer requestHandlerConcurrency)

Sets the handler concurrency level for MCP JSON-RPC request handling.

On runtimes with virtual threads, established MCP live GET streams are processed on a virtual-thread-per-stream executor and are not limited by this value. On runtimes without virtual threads, the live-stream processor uses the bounded fallback executor and this value also bounds active live-stream processing.

Parameters:

requestHandlerConcurrency - the handler concurrency

Returns:

this builder

requestHandlerQueueCapacity

public @NonNull McpServer.Builder requestHandlerQueueCapacity(@Nullable Integer requestHandlerQueueCapacity)

Sets the handler queue capacity for MCP JSON-RPC request handling.

Parameters:

requestHandlerQueueCapacity - the handler queue capacity

Returns:

this builder

requestHandlerExecutorServiceSupplier

public @NonNull McpServer.Builder requestHandlerExecutorServiceSupplier(@Nullable Supplier<ExecutorService> requestHandlerExecutorServiceSupplier)

Sets the supplier used to create the handler executor service.

Parameters:

requestHandlerExecutorServiceSupplier - the executor service supplier

Returns:

this builder

maximumRequestSizeInBytes

public @NonNull McpServer.Builder maximumRequestSizeInBytes(@Nullable Integer maximumRequestSizeInBytes)

Sets the maximum accepted MCP request size in bytes.

The MCP transport rejects requests whose declared body size is larger than this limit. Header-section size is governed by maximumHeadersSizeInBytes(Integer).

Parameters:

maximumRequestSizeInBytes - the maximum request size, or null for the default

Returns:

this builder

maximumHeaderCount

public @NonNull McpServer.Builder maximumHeaderCount(@Nullable Integer maximumHeaderCount)

Sets the maximum number of HTTP header fields accepted in one MCP request.

Parameters:

maximumHeaderCount - the maximum header count, or null for the default

Returns:

this builder

maximumHeadersSizeInBytes

public @NonNull McpServer.Builder maximumHeadersSizeInBytes(@Nullable Integer maximumHeadersSizeInBytes)

Sets the maximum accepted MCP HTTP header-section size in bytes.

This limit applies to the header bytes after the request line, including header-field line endings and the terminating blank line.

Parameters:

maximumHeadersSizeInBytes - the maximum headers size, or null for the default

Returns:

this builder

maximumRequestTargetLengthInBytes

public @NonNull McpServer.Builder maximumRequestTargetLengthInBytes(@Nullable Integer maximumRequestTargetLengthInBytes)

Sets the maximum MCP HTTP request-target length accepted in bytes.

Parameters:

maximumRequestTargetLengthInBytes - the maximum request-target length, or null for the default

Returns:

this builder

requestReadBufferSizeInBytes

public @NonNull McpServer.Builder requestReadBufferSizeInBytes(@Nullable Integer requestReadBufferSizeInBytes)

Sets the read buffer size used while reading MCP requests.

Parameters:

requestReadBufferSizeInBytes - the read buffer size

Returns:

this builder

concurrentConnectionLimit

public @NonNull McpServer.Builder concurrentConnectionLimit(@Nullable Integer concurrentConnectionLimit)

Sets the concurrent connection limit for the MCP server.

A value of 0 disables Soklet's MCP live-stream connection cap entirely. Use 0 only when an external proxy, load balancer, operating-system limit, or custom admission policy provides the intended production cap.

Parameters:

concurrentConnectionLimit - the concurrent connection limit

Returns:

this builder

connectionQueueCapacity

public @NonNull McpServer.Builder connectionQueueCapacity(@Nullable Integer connectionQueueCapacity)

Sets the outbound queue capacity for live MCP streams.

This controls each established stream's outbound message queue. On runtimes without virtual threads, the same value is also used by the bounded fallback executor for queued live-stream processing tasks.

Parameters:

connectionQueueCapacity - the outbound queue capacity

Returns:

this builder

shutdownTimeout

public @NonNull McpServer.Builder shutdownTimeout(@Nullable Duration shutdownTimeout)

Sets the shutdown timeout.

Parameters:

shutdownTimeout - the shutdown timeout

Returns:

this builder

writeTimeout

public @NonNull McpServer.Builder writeTimeout(@Nullable Duration writeTimeout)

Sets the transport write timeout for established MCP event streams.

If this value is not specified, Soklet uses the server default. Use Duration.ZERO to disable MCP event-stream write timeouts.

Parameters:

writeTimeout - the write timeout, or null for the default

Returns:

this builder

heartbeatInterval

public @NonNull McpServer.Builder heartbeatInterval(@Nullable Duration heartbeatInterval)

Sets the heartbeat interval for long-lived MCP event streams.

Parameters:

heartbeatInterval - the heartbeat interval

Returns:

this builder

build

public @NonNull McpServer build()

Builds the MCP server.

Returns:

the built MCP server