Class McpToolRegistration<A>

java.lang.Object

com.soklet.McpToolRegistration<A>

Type Parameters:

A - bound argument type

@ThreadSafe
public final class McpToolRegistration<A>
extends Object

Immutable programmatic registration for one MCP tool.

Registration is staged: choose a name, choose typed, fixed raw-JSON, or authored-schema raw-JSON arguments, provide a handler, configure optional metadata, and explicitly call build(). Typed and authored schemas and their binding plans compile synchronously while the required inputs are still in hand. A typed-output stage can select an always-complete handler, an inline advanced handler, or a statically task-required operation handler while retaining the same output contract.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	McpToolRegistration.ArgumentTypeStage	Staged selection of a tool's argument and output shapes.
static final class	McpToolRegistration.CompleteBuilder<A>	Builder for a tool that always completes with a supported structured Java result.
static final class	McpToolRegistration.CompleteHandlerStage<A,R>	Handler-selection stage for a typed-output path.
static final class	McpToolRegistration.OperationBuilder<A>	Builder for an advanced handler that returns the McpOperationResult spine directly.
static final class	McpToolRegistration.OperationHandlerStage<A>	Handler-selection stage for the advanced operation-result path.

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<@NonNull McpAppToolMetadata>	getAppToolMetadata()	Returns typed Apps association and audience metadata, if configured.
@NonNull Type	getArgumentType()
@NonNull Optional<@NonNull String>	getDescription()
@NonNull McpToolHandler<@NonNull A>	getHandler()	Returns the normalized advanced handler.
@NonNull List<@NonNull McpIcon>	getIcons()
@NonNull List<@NonNull McpInputRequestDeclaration>	getInputRequestDeclarations()	Returns the input requests this advanced operation may emit.
@NonNull McpToolSchema	getInputSchema()
@NonNull McpJsonObject	getMetadata()
@NonNull String	getName()
@NonNull Optional<@NonNull McpToolSchema>	getOutputSchema()
@NonNull Optional<@NonNull Type>	getOutputType()	Returns the Java output type from which Soklet derived a schema.
@NonNull Set<@NonNull McpProtocolVersion>	getProtocolVersions()
@NonNull Optional<@NonNull McpRateLimiter>	getRateLimiter()	Returns the direct rate-limiter override.
@NonNull Optional<@NonNull String>	getRateLimiterName()	Returns the named rate-limiter override.
@NonNull McpRequestStateMode	getRequestStateMode()	Returns the request-state contract for this operation.
@NonNull Optional<@NonNull String>	getTitle()
@NonNull Optional<@NonNull McpToolAnnotations>	getToolAnnotations()
@NonNull Boolean	isStructuredContentMirroredAsText()	Indicates whether structured content is also mirrored as canonical JSON text in the tool's content array.
static @NonNull McpToolRegistration.ArgumentTypeStage	withName(@NonNull String name, @NonNull Set<@NonNull McpProtocolVersion> protocolVersions)	Begins a staged registration for a named tool.

Methods inherited from class Object

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

Method Details

withName

public static @NonNull McpToolRegistration.ArgumentTypeStage withName(@NonNull String name,
 @NonNull Set<@NonNull McpProtocolVersion> protocolVersions)

Begins a staged registration for a named tool.

The next stage selects typed, fixed raw-JSON, or authored-schema raw-JSON arguments. Supplying both argument and output types selects a typed-output path whose next stage chooses inline completion or a statically task-required operation; supplying only an argument type selects the untyped advanced McpOperationResult path. No stage exposes build() before a handler has been supplied.

Parameters:

name - published MCP tool name

protocolVersions - nonempty exact revisions serving this tool

Returns:

argument-shape selection stage

Throws:

IllegalArgumentException - if the name is not 1-128 characters from A-Z, a-z, 0-9, underscore, hyphen, and dot

getName

public @NonNull String getName()

Returns:

published MCP tool name

getProtocolVersions

public @NonNull Set<@NonNull McpProtocolVersion> getProtocolVersions()

Returns:

exact protocol revisions on which this tool is available

getTitle

public @NonNull Optional<@NonNull String> getTitle()

Returns:

human-readable title, if configured

getDescription

public @NonNull Optional<@NonNull String> getDescription()

Returns:

human-readable description, if configured

getIcons

public @NonNull List<@NonNull McpIcon> getIcons()

Returns:

immutable icon list in registration order

getArgumentType

public @NonNull Type getArgumentType()

Returns:

declared Java argument type

getInputSchema

public @NonNull McpToolSchema getInputSchema()

Returns:

derived, fixed, or application-authored input schema

getOutputSchema

public @NonNull Optional<@NonNull McpToolSchema> getOutputSchema()

Returns:

generated output schema for a typed-output registration

getOutputType

public @NonNull Optional<@NonNull Type> getOutputType()

Returns the Java output type from which Soklet derived a schema.

Returns:

declared output type for a typed-output registration

getToolAnnotations

public @NonNull Optional<@NonNull McpToolAnnotations> getToolAnnotations()

Returns:

advisory tool annotations, if configured

getAppToolMetadata

public @NonNull Optional<@NonNull McpAppToolMetadata> getAppToolMetadata()

Returns typed Apps association and audience metadata, if configured.

Raw application metadata remains separately available from getMetadata(); this accessor does not parse raw Apps fields.

Returns:

typed Apps tool metadata

getRateLimiterName

public @NonNull Optional<@NonNull String> getRateLimiterName()

Returns the named rate-limiter override.

At most one of this value and getRateLimiter() is present.

Returns:

limiter name, or empty for a direct or inherited limiter

getRateLimiter

public @NonNull Optional<@NonNull McpRateLimiter> getRateLimiter()

Returns the direct rate-limiter override.

At most one of this value and getRateLimiterName() is present.

Returns:

direct limiter, or empty for a named or inherited limiter

isStructuredContentMirroredAsText

public @NonNull Boolean isStructuredContentMirroredAsText()

Indicates whether structured content is also mirrored as canonical JSON text in the tool's content array.

Returns:

true when mirroring is enabled

getInputRequestDeclarations

public @NonNull List<@NonNull McpInputRequestDeclaration> getInputRequestDeclarations()

Returns the input requests this advanced operation may emit.

Returns:

immutable declarations in registration order

getRequestStateMode

public @NonNull McpRequestStateMode getRequestStateMode()

Returns the request-state contract for this operation.

Returns:

request-state mode

getMetadata

public @NonNull McpJsonObject getMetadata()

Returns:

immutable protocol extension metadata

getHandler

public @NonNull McpToolHandler<@NonNull A> getHandler()

Returns the normalized advanced handler.

For an always-complete typed registration, Soklet supplies an adapter that converts the Java result with the same compiled binding that generated getOutputSchema().

Returns:

normalized handler