McpServer.StatelessSyncSpecification

java.lang.Object
- io.modelcontextprotocol.server.McpServer.StatelessSyncSpecification

封闭接口:: McpServer

public static class McpServer.StatelessSyncSpecification
extends java.lang.Object

构造器概要

构造器
构造器和说明

StatelessSyncSpecification(McpStatelessServerTransport transport)

构造器
构造器和说明
`StatelessSyncSpecification(McpStatelessServerTransport transport)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`McpStatelessSyncServer`	`build()`
`McpServer.StatelessSyncSpecification`	`capabilities(McpSchema.ServerCapabilities serverCapabilities)` Sets the server capabilities that will be advertised to clients during connection initialization.
`McpServer.StatelessSyncSpecification`	`completions(java.util.List<McpStatelessServerFeatures.SyncCompletionSpecification> completions)` Registers multiple completions with their handlers using a List.
`McpServer.StatelessSyncSpecification`	`completions(McpStatelessServerFeatures.SyncCompletionSpecification... completions)` Registers multiple completions with their handlers using varargs.
`McpServer.StatelessSyncSpecification`	`immediateExecution(boolean immediateExecution)` Enable on "immediate execution" of the operations on the underlying `McpStatelessAsyncServer`.
`McpServer.StatelessSyncSpecification`	`instructions(java.lang.String instructions)` Sets the server instructions that will be shared with clients during connection initialization.
`McpServer.StatelessSyncSpecification`	`jsonSchemaValidator(JsonSchemaValidator jsonSchemaValidator)` Sets the JSON schema validator to use for validating tool and resource schemas.
`McpServer.StatelessSyncSpecification`	`objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Sets the object mapper to use for serializing and deserializing JSON messages.
`McpServer.StatelessSyncSpecification`	`prompts(java.util.List<McpStatelessServerFeatures.SyncPromptSpecification> prompts)` Registers multiple prompts with their handlers using a List.
`McpServer.StatelessSyncSpecification`	`prompts(java.util.Map<java.lang.String,McpStatelessServerFeatures.SyncPromptSpecification> prompts)` Registers multiple prompts with their handlers using a Map.
`McpServer.StatelessSyncSpecification`	`prompts(McpStatelessServerFeatures.SyncPromptSpecification... prompts)` Registers multiple prompts with their handlers using varargs.
`McpServer.StatelessSyncSpecification`	`requestTimeout(java.time.Duration requestTimeout)` Sets the duration to wait for server responses before timing out requests.
`McpServer.StatelessSyncSpecification`	`resources(java.util.List<McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)` Registers multiple resources with their handlers using a List.
`McpServer.StatelessSyncSpecification`	`resources(java.util.Map<java.lang.String,McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)` Registers multiple resources with their handlers using a Map.
`McpServer.StatelessSyncSpecification`	`resources(McpStatelessServerFeatures.SyncResourceSpecification... resourceSpecifications)` Registers multiple resources with their handlers using varargs.
`McpServer.StatelessSyncSpecification`	`resourceTemplates(java.util.List<McpSchema.ResourceTemplate> resourceTemplates)` Sets the resource templates that define patterns for dynamic resource access.
`McpServer.StatelessSyncSpecification`	`resourceTemplates(McpSchema.ResourceTemplate... resourceTemplates)` Sets the resource templates using varargs for convenience.
`McpServer.StatelessSyncSpecification`	`serverInfo(McpSchema.Implementation serverInfo)` Sets the server implementation information that will be shared with clients during connection initialization.
`McpServer.StatelessSyncSpecification`	`serverInfo(java.lang.String name, java.lang.String version)` Sets the server implementation information using name and version strings.
`McpServer.StatelessSyncSpecification`	`toolCall(McpSchema.Tool tool, java.util.function.BiFunction<McpTransportContext,McpSchema.CallToolRequest,McpSchema.CallToolResult> callHandler)` Adds a single tool with its implementation handler to the server.
`McpServer.StatelessSyncSpecification`	`tools(java.util.List<McpStatelessServerFeatures.SyncToolSpecification> toolSpecifications)` Adds multiple tools with their handlers to the server using a List.
`McpServer.StatelessSyncSpecification`	`tools(McpStatelessServerFeatures.SyncToolSpecification... toolSpecifications)` Adds multiple tools with their handlers to the server using varargs.
`McpServer.StatelessSyncSpecification`	`uriTemplateManagerFactory(McpUriTemplateManagerFactory uriTemplateManagerFactory)` Sets the URI template manager factory to use for creating URI templates.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - StatelessSyncSpecification
```
public StatelessSyncSpecification(McpStatelessServerTransport transport)
```
- 方法详细资料
  - uriTemplateManagerFactory
```
public McpServer.StatelessSyncSpecification uriTemplateManagerFactory(McpUriTemplateManagerFactory uriTemplateManagerFactory)
```
    Sets the URI template manager factory to use for creating URI templates. This allows for custom URI template parsing and variable extraction.
    
    参数:
    
    uriTemplateManagerFactory - The factory to use. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if uriTemplateManagerFactory is null
  - requestTimeout
```
public McpServer.StatelessSyncSpecification requestTimeout(java.time.Duration requestTimeout)
```
    Sets the duration to wait for server responses before timing out requests. This timeout applies to all requests made through the client, including tool calls, resource access, and prompt operations.
    
    参数:
    
    requestTimeout - The duration to wait before timing out requests. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if requestTimeout is null
  - serverInfo
```
public McpServer.StatelessSyncSpecification serverInfo(McpSchema.Implementation serverInfo)
```
    Sets the server implementation information that will be shared with clients during connection initialization. This helps with version compatibility, debugging, and server identification.
    
    参数:
    
    serverInfo - The server implementation details including name and version. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if serverInfo is null
  - serverInfo
```
public McpServer.StatelessSyncSpecification serverInfo(java.lang.String name,
                                                       java.lang.String version)
```
    Sets the server implementation information using name and version strings. This is a convenience method alternative to serverInfo(McpSchema.Implementation).
    
    参数:
    
    name - The server name. Must not be null or empty.
    
    version - The server version. Must not be null or empty.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if name or version is null or empty
    
    另请参阅:
    
    serverInfo(McpSchema.Implementation)
  - instructions
```
public McpServer.StatelessSyncSpecification instructions(java.lang.String instructions)
```
    Sets the server instructions that will be shared with clients during connection initialization. These instructions provide guidance to the client on how to interact with this server.
    
    参数:
    
    instructions - The instructions text. Can be null or empty.
    
    返回:
    
    This builder instance for method chaining
  - capabilities
```
public McpServer.StatelessSyncSpecification capabilities(McpSchema.ServerCapabilities serverCapabilities)
```
    Sets the server capabilities that will be advertised to clients during connection initialization. Capabilities define what features the server supports, such as:
    - Tool execution
    - Resource access
    - Prompt handling
    参数:
    
    serverCapabilities - The server capabilities configuration. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if serverCapabilities is null
  - toolCall
```
public McpServer.StatelessSyncSpecification toolCall(McpSchema.Tool tool,
                                                     java.util.function.BiFunction<McpTransportContext,McpSchema.CallToolRequest,McpSchema.CallToolResult> callHandler)
```
    Adds a single tool with its implementation handler to the server. This is a convenience method for registering individual tools without creating a McpServerFeatures.SyncToolSpecification explicitly.
    
    参数:
    
    tool - The tool definition including name, description, and schema. Must not be null.
    
    callHandler - The function that implements the tool's logic. Must not be null. The function's first argument is an McpSyncServerExchange upon which the server can interact with the connected client. The second argument is the McpSchema.CallToolRequest object containing the tool call
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if tool or handler is null
  - tools
```
public McpServer.StatelessSyncSpecification tools(java.util.List<McpStatelessServerFeatures.SyncToolSpecification> toolSpecifications)
```
    Adds multiple tools with their handlers to the server using a List. This method is useful when tools are dynamically generated or loaded from a configuration source.
    
    参数:
    
    toolSpecifications - The list of tool specifications to add. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if toolSpecifications is null
    
    另请参阅:
    
    tools(McpStatelessServerFeatures.SyncToolSpecification...)
  - tools
```
public McpServer.StatelessSyncSpecification tools(McpStatelessServerFeatures.SyncToolSpecification... toolSpecifications)
```
    Adds multiple tools with their handlers to the server using varargs. This method provides a convenient way to register multiple tools inline.
    Example usage:
```
 .tools(
     McpServerFeatures.SyncToolSpecification.builder().tool(calculatorTool).callTool(calculatorHandler).build(),
     McpServerFeatures.SyncToolSpecification.builder().tool(weatherTool).callTool(weatherHandler).build(),
     McpServerFeatures.SyncToolSpecification.builder().tool(fileManagerTool).callTool(fileManagerHandler).build()
 )
 
```
    参数:
    
    toolSpecifications - The tool specifications to add. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if toolSpecifications is null
  - resources
```
public McpServer.StatelessSyncSpecification resources(java.util.Map<java.lang.String,McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)
```
    Registers multiple resources with their handlers using a Map. This method is useful when resources are dynamically generated or loaded from a configuration source.
    
    参数:
    
    resourceSpecifications - Map of resource name to specification. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if resourceSpecifications is null
    
    另请参阅:
    
    resources(McpStatelessServerFeatures.SyncResourceSpecification...)
  - resources
```
public McpServer.StatelessSyncSpecification resources(java.util.List<McpStatelessServerFeatures.SyncResourceSpecification> resourceSpecifications)
```
    Registers multiple resources with their handlers using a List. This method is useful when resources need to be added in bulk from a collection.
    
    参数:
    
    resourceSpecifications - List of resource specifications. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if resourceSpecifications is null
    
    另请参阅:
    
    resources(McpStatelessServerFeatures.SyncResourceSpecification...)
  - resources
```
public McpServer.StatelessSyncSpecification resources(McpStatelessServerFeatures.SyncResourceSpecification... resourceSpecifications)
```
    Registers multiple resources with their handlers using varargs. This method provides a convenient way to register multiple resources inline.
    Example usage:
```
 .resources(
     new McpServerFeatures.SyncResourceSpecification(fileResource, fileHandler),
     new McpServerFeatures.SyncResourceSpecification(dbResource, dbHandler),
     new McpServerFeatures.SyncResourceSpecification(apiResource, apiHandler)
 )
 
```
    参数:
    
    resourceSpecifications - The resource specifications to add. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if resourceSpecifications is null
  - resourceTemplates
```
public McpServer.StatelessSyncSpecification resourceTemplates(java.util.List<McpSchema.ResourceTemplate> resourceTemplates)
```
    Sets the resource templates that define patterns for dynamic resource access. Templates use URI patterns with placeholders that can be filled at runtime.
    Example usage:
```
 .resourceTemplates(
     new ResourceTemplate("file://{path}", "Access files by path"),
     new ResourceTemplate("db://{table}/{id}", "Access database records")
 )
 
```
    参数:
    
    resourceTemplates - List of resource templates. If null, clears existing templates.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if resourceTemplates is null.
    
    另请参阅:
    
    #resourceTemplates(ResourceTemplate...)
  - resourceTemplates
```
public McpServer.StatelessSyncSpecification resourceTemplates(McpSchema.ResourceTemplate... resourceTemplates)
```
    Sets the resource templates using varargs for convenience. This is an alternative to resourceTemplates(List).
    
    参数:
    
    resourceTemplates - The resource templates to set.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if resourceTemplates is null.
    
    另请参阅:
    
    resourceTemplates(List)
  - prompts
```
public McpServer.StatelessSyncSpecification prompts(java.util.Map<java.lang.String,McpStatelessServerFeatures.SyncPromptSpecification> prompts)
```
    Registers multiple prompts with their handlers using a Map. This method is useful when prompts are dynamically generated or loaded from a configuration source.
    Example usage:
```
 .prompts(Map.of("analysis", new McpServerFeatures.SyncPromptSpecification(
     new Prompt("analysis", "Code analysis template"),
     request -> Mono.fromSupplier(() -> generateAnalysisPrompt(request))
         .map(GetPromptResult::new)
 )));
 
```
    参数:
    
    prompts - Map of prompt name to specification. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if prompts is null
  - prompts
```
public McpServer.StatelessSyncSpecification prompts(java.util.List<McpStatelessServerFeatures.SyncPromptSpecification> prompts)
```
    Registers multiple prompts with their handlers using a List. This method is useful when prompts need to be added in bulk from a collection.
    
    参数:
    
    prompts - List of prompt specifications. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if prompts is null
    
    另请参阅:
    
    prompts(McpStatelessServerFeatures.SyncPromptSpecification...)
  - prompts
```
public McpServer.StatelessSyncSpecification prompts(McpStatelessServerFeatures.SyncPromptSpecification... prompts)
```
    Registers multiple prompts with their handlers using varargs. This method provides a convenient way to register multiple prompts inline.
    Example usage:
```
 .prompts(
     new McpServerFeatures.SyncPromptSpecification(analysisPrompt, analysisHandler),
     new McpServerFeatures.SyncPromptSpecification(summaryPrompt, summaryHandler),
     new McpServerFeatures.SyncPromptSpecification(reviewPrompt, reviewHandler)
 )
 
```
    参数:
    
    prompts - The prompt specifications to add. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if prompts is null
  - completions
```
public McpServer.StatelessSyncSpecification completions(java.util.List<McpStatelessServerFeatures.SyncCompletionSpecification> completions)
```
    Registers multiple completions with their handlers using a List. This method is useful when completions need to be added in bulk from a collection.
    
    参数:
    
    completions - List of completion specifications. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if completions is null
  - completions
```
public McpServer.StatelessSyncSpecification completions(McpStatelessServerFeatures.SyncCompletionSpecification... completions)
```
    Registers multiple completions with their handlers using varargs. This method is useful when completions are defined inline and added directly.
    
    参数:
    
    completions - Array of completion specifications. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if completions is null
  - objectMapper
```
public McpServer.StatelessSyncSpecification objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Sets the object mapper to use for serializing and deserializing JSON messages.
    
    参数:
    
    objectMapper - the instance to use. Must not be null.
    
    返回:
    
    This builder instance for method chaining.
    
    抛出:
    
    java.lang.IllegalArgumentException - if objectMapper is null
  - jsonSchemaValidator
```
public McpServer.StatelessSyncSpecification jsonSchemaValidator(JsonSchemaValidator jsonSchemaValidator)
```
    Sets the JSON schema validator to use for validating tool and resource schemas. This ensures that the server's tools and resources conform to the expected schema definitions.
    
    参数:
    
    jsonSchemaValidator - The validator to use. Must not be null.
    
    返回:
    
    This builder instance for method chaining
    
    抛出:
    
    java.lang.IllegalArgumentException - if jsonSchemaValidator is null
  - immediateExecution
```
public McpServer.StatelessSyncSpecification immediateExecution(boolean immediateExecution)
```
    Enable on "immediate execution" of the operations on the underlying McpStatelessAsyncServer. Defaults to false, which does blocking code offloading to prevent accidental blocking of the non-blocking transport.
    Do NOT set to true if the underlying transport is a non-blocking implementation.
    
    参数:
    
    immediateExecution - When true, do not offload work asynchronously.
    
    返回:
    
    This builder instance for method chaining.
  - build
```
public McpStatelessSyncServer build()
```

类 McpServer.StatelessSyncSpecification

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

StatelessSyncSpecification

方法详细资料

uriTemplateManagerFactory

requestTimeout

serverInfo

serverInfo

instructions

capabilities

toolCall

tools

tools

resources

resources

resources

resourceTemplates

resourceTemplates

prompts

prompts

prompts

completions

completions

objectMapper

jsonSchemaValidator

immediateExecution

build