io.modelcontextprotocol.server

Class McpServerFeatures.SyncToolSpecification

java.lang.Object

io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification

Enclosing class:

McpServerFeatures

public static class McpServerFeatures.SyncToolSpecification
extends Object

Specification of a tool with its synchronous handler function. Tools are the primary way for MCP servers to expose functionality to AI models.

Example tool specification:

 McpServerFeatures.SyncToolSpecification.builder()
 		.tool(new Tool(
 				"calculator",
 				"Performs mathematical calculations",
 				new JsonSchemaObject()
 						.required("expression")
 						.property("expression", JsonSchemaType.STRING)))
 		.toolHandler((exchange, req) -> {
 			String expr = (String) req.arguments().get("expression");
 			return new CallToolResult("Result: " + evaluate(expr));
 		}))
      .build();
 

McpSyncServerExchange upon which the server can interact with the connected McpSyncServerExchange and a McpSchema.CallToolRequest and returning results. The function's first argument is an McpSyncServerExchange upon which the server can interact with the client. The second arguments is a map of arguments passed to the tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	McpServerFeatures.SyncToolSpecification.Builder Builder for creating SyncToolSpecification instances.

Constructor Summary

Constructors

Constructor and Description
SyncToolSpecification(McpSchema.Tool tool, BiFunction<McpSyncServerExchange,Map<String,Object>,McpSchema.CallToolResult> call) Deprecated.

Method Summary

Modifier and Type	Method and Description
static McpServerFeatures.SyncToolSpecification.Builder	builder() Creates a new builder instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncToolSpecification

@Deprecated
public SyncToolSpecification(McpSchema.Tool tool,
                                         BiFunction<McpSyncServerExchange,Map<String,Object>,McpSchema.CallToolResult> call)

Deprecated.

Method Detail

builder

public static McpServerFeatures.SyncToolSpecification.Builder builder()

Creates a new builder instance.

Returns:

a new Builder instance