Module io.modelcontextprotocol.sdk.mcp
Package io.modelcontextprotocol.server

Record Class McpServerFeatures.SyncToolSpecification

java.lang.Object
java.lang.Record
io.modelcontextprotocol.server.McpServerFeatures.SyncToolSpecification
Record Components:
tool - The tool definition including name, description, and parameter schema
call - The function that implements the tool's logic, receiving arguments and returning results. The function's first argument is an McpSyncServerExchange upon which the server can interact with the connected client. The second arguments is a map of arguments passed to the tool.
Enclosing class:
McpServerFeatures
public static record McpServerFeatures.SyncToolSpecification(McpSchema.Tool tool, BiFunction<McpSyncServerExchange,Map<String,Object>,McpSchema.CallToolResult> call) extends Record
Specification of a tool with its synchronous handler function. Tools are the primary way for MCP servers to expose functionality to AI models. Each tool represents a specific capability, such as:
  • Performing calculations
  • Accessing external APIs
  • Querying databases
  • Manipulating files
  • Executing system commands

Example tool specification: 


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

  • Constructor Details

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • tool

      public McpSchema.Tool tool()
      Returns the value of the tool record component.
      Returns:
      the value of the tool record component

    • call

      public BiFunction<McpSyncServerExchange,Map<String,Object>,McpSchema.CallToolResult> call()
      Returns the value of the call record component.
      Returns:
      the value of the call record component