All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
McpClientConfig.BuilderBase.McpClientConfigImpl

public interface McpClientConfig extends Prototype.Api
Interface generated from definition. Please add javadoc to the definition interface.
See Also:
  • Field Details

  • Method Details

    • builder

      static McpClientConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder
    • builder

      static McpClientConfig.Builder builder(McpClientConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance
    • create

      static McpClientConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      @Deprecated static McpClientConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      static McpClientConfig create()
      Create a new instance with default values.
      Returns:
      a new instance
    • sseUri

      URI sseUri()
      The initial URI where to connect to the server and request a SSE channel.
      Returns:
      sse uri
    • clientName

      Optional<String> clientName()
      Sets the name that the client will use to identify itself to the MCP server in the initialization message. Overwrites the default client name from langchain4j.
      Returns:
      client name
    • clientVersion

      Optional<String> clientVersion()
      Sets the version string that the client will use to identify itself to the MCP server in the initialization message. Overwrites the default client version from langchain4j.
      Returns:
      client version
    • key

      Sets a unique identifier for the client. If none is provided, a UUID will be automatically generated. This key is later used to identify the client in the service registry.
      Returns:
      client key
    • protocolVersion

      Optional<String> protocolVersion()
      Sets the protocol version that the client will advertise in the initialization message. Overwrites the default version from langchain4j.
      Returns:
      protocol version
    • initializationTimeout

      Optional<Duration> initializationTimeout()
      Sets the timeout for initializing the client. Overwrites the default timeout for initializing from langchain4j.
      Returns:
      initialization timout
    • toolExecutionTimeout

      Optional<Duration> toolExecutionTimeout()
      Sets the timeout for tool execution. This value applies to each tool execution individually. A value of zero means no timeout. Overwrites the default timeout for tool execution from langchain4j.
      Returns:
      tool execution timout
    • resourcesTimeout

      Optional<Duration> resourcesTimeout()
      Sets the timeout for resource-related operations (listing resources as well as reading the contents of a resource). A value of zero means no timeout. Overwrites the default timeout for resource-related operations from langchain4j.
      Returns:
      resources timeout
    • promptsTimeout

      Optional<Duration> promptsTimeout()
      The timeout for prompt-related operations (listing prompts as well as rendering the contents of a prompt). A value of zero means no timeout. Overwrites the default timeout for prompt-related operations from langchain4j.
      Returns:
      prompts timeout
    • pingTimeout

      Optional<Duration> pingTimeout()
      The timeout to apply when waiting for a ping response. Overwrites the default timeout when waiting for a ping response from langchain4j.
      Returns:
      ping timeout
    • reconnectInterval

      Optional<Duration> reconnectInterval()
      The delay before attempting to reconnect after a failed connection. Overwrites the default reconnect interval from langchain4j.
      Returns:
      reconnect interval
    • toolExecutionTimeoutErrorMessage

      Optional<String> toolExecutionTimeoutErrorMessage()
      The error message to return when a tool execution times out. Overwrites the default error message from langchain4j.
      Returns:
      time out error message
    • logRequests

      Optional<Boolean> logRequests()
      Whether to log request traffic.
      Returns:
      log request traffic
    • logResponses

      Optional<Boolean> logResponses()
      Whether to log response traffic.
      Returns:
      log response traffic