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

Record Class McpServerFeatures.SyncPromptSpecification

java.lang.Object
java.lang.Record
io.modelcontextprotocol.server.McpServerFeatures.SyncPromptSpecification
Record Components:
prompt - The prompt definition including name and description
promptHandler - The function that processes prompt requests and returns formatted templates. The function's first argument is an McpSyncServerExchange upon which the server can interact with the connected client. The second arguments is a McpSchema.GetPromptRequest.
Enclosing class:
McpServerFeatures
public static record McpServerFeatures.SyncPromptSpecification(McpSchema.Prompt prompt, BiFunction<McpSyncServerExchange,McpSchema.GetPromptRequest,McpSchema.GetPromptResult> promptHandler) extends Record
Specification of a prompt template with its synchronous handler function. Prompts provide structured templates for AI model interactions, supporting:
  • Consistent message formatting
  • Parameter substitution
  • Context injection
  • Response formatting
  • Instruction templating

Example prompt specification: 


 new McpServerFeatures.SyncPromptSpecification(
 		new Prompt("analyze", "Code analysis template"),
 		(exchange, request) -> {
 			String code = request.getArguments().get("code");
 			return new GetPromptResult(
 					"Analyze this code:\n\n" + code + "\n\nProvide feedback on:");
 		})

  • 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.

    • prompt

      public McpSchema.Prompt prompt()
      Returns the value of the prompt record component.
      Returns:
      the value of the prompt record component

    • promptHandler

      public BiFunction<McpSyncServerExchange,McpSchema.GetPromptRequest,McpSchema.GetPromptResult> promptHandler()
      Returns the value of the promptHandler record component.
      Returns:
      the value of the promptHandler record component