Package dev.langchain4j.mcp.client
Class DefaultMcpClient.Builder
java.lang.Object
dev.langchain4j.mcp.client.DefaultMcpClient.Builder
- Enclosing class:
DefaultMcpClient
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
clientName
(String clientName) Sets the name that the client will use to identify itself to the MCP server in the initialization message.clientVersion
(String clientVersion) Sets the version string that the client will use to identify itself to the MCP server in the initialization message.initializationTimeout
(Duration initializationTimeout) Sets the timeout for initializing the client.logHandler
(McpLogMessageHandler logHandler) Sets the log message handler for the client.pingTimeout
(Duration pingTimeout) The timeout to apply when waiting for a ping response.promptsTimeout
(Duration promptsTimeout) Sets the timeout for prompt-related operations (listing prompts as well as rendering the contents of a prompt).protocolVersion
(String protocolVersion) Sets the protocol version that the client will advertise in the initialization message.reconnectInterval
(Duration reconnectInterval) The delay before attempting to reconnect after a failed connection.resourcesTimeout
(Duration resourcesTimeout) Sets the timeout for resource-related operations (listing resources as well as reading the contents of a resource).toolExecutionTimeout
(Duration toolExecutionTimeout) Sets the timeout for tool execution.toolExecutionTimeoutErrorMessage
(String toolExecutionTimeoutErrorMessage) Sets the error message to return when a tool execution times out.transport
(McpTransport transport)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
transport
-
clientName
Sets the name that the client will use to identify itself to the MCP server in the initialization message. The default value is "langchain4j". -
clientVersion
Sets the version string that the client will use to identify itself to the MCP server in the initialization message. The default value is "1.0". -
protocolVersion
Sets the protocol version that the client will advertise in the initialization message. The default value right now is "2024-11-05", but will change over time in later langchain4j versions. -
initializationTimeout
Sets the timeout for initializing the client. The default value is 30 seconds. -
toolExecutionTimeout
Sets the timeout for tool execution. This value applies to each tool execution individually. The default value is 60 seconds. A value of zero means no timeout. -
resourcesTimeout
Sets the timeout for resource-related operations (listing resources as well as reading the contents of a resource). The default value is 60 seconds. A value of zero means no timeout. -
promptsTimeout
Sets the timeout for prompt-related operations (listing prompts as well as rendering the contents of a prompt). The default value is 60 seconds. A value of zero means no timeout. -
toolExecutionTimeoutErrorMessage
public DefaultMcpClient.Builder toolExecutionTimeoutErrorMessage(String toolExecutionTimeoutErrorMessage) Sets the error message to return when a tool execution times out. The default value is "There was a timeout executing the tool". -
logHandler
Sets the log message handler for the client. -
pingTimeout
The timeout to apply when waiting for a ping response. Currently, this is only used in the health check - if the server does not send a pong within this timeframe, the health check will fail. The timeout is 10 seconds. -
reconnectInterval
The delay before attempting to reconnect after a failed connection. The default is 5 seconds. -
build
-