Package com.commercetools.api.models.mcp_server

Interface McpServerDraft

All Superinterfaces:
Draft<McpServerDraft>
public interface McpServerDraft extends Draft<McpServerDraft>

Draft representation for creating a new MCP Server.

Example to create an instance using the builder pattern 

     McpServerDraft mcpServerDraft = McpServerDraft.builder()
             .key("{key}")
             .mcpServer(mcpServerBuilder -> mcpServerBuilder)
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier for the MCP Server. Must be unique within the Project.

      Returns:
      key

    • getName

      @Valid @Valid LocalizedString getName()

      Name of the MCP Server.

      Returns:
      name

    • getDescription

      @Valid @Valid LocalizedString getDescription()

      Description of the MCP Server.

      Returns:
      description

    • getAuthenticationMode

      McpServerAuthenticationMode getAuthenticationMode()

      Determines how AI agents authenticate when connecting to the MCP Server.

      Returns:
      authenticationMode

    • getState

      McpServerState getState()

      State of the MCP Server.

      Returns:
      state

    • getMcpServer

      @NotNull @Valid @NotNull @Valid McpServerConfigDraft getMcpServer()

      Configuration of the MCP Server connection.

      Returns:
      mcpServer

    • setKey

      void setKey(String key)

      User-defined unique identifier for the MCP Server. Must be unique within the Project.

      Parameters:
      key - value to be set

    • setName

      void setName(LocalizedString name)

      Name of the MCP Server.

      Parameters:
      name - value to be set

    • setDescription

      void setDescription(LocalizedString description)

      Description of the MCP Server.

      Parameters:
      description - value to be set

    • setAuthenticationMode

      void setAuthenticationMode(McpServerAuthenticationMode authenticationMode)

      Determines how AI agents authenticate when connecting to the MCP Server.

      Parameters:
      authenticationMode - value to be set

    • setState

      void setState(McpServerState state)

      State of the MCP Server.

      Parameters:
      state - value to be set

    • setMcpServer

      void setMcpServer(McpServerConfigDraft mcpServer)

      Configuration of the MCP Server connection.

      Parameters:
      mcpServer - value to be set

    • of

      static McpServerDraft of()
      factory method
      Returns:
      instance of McpServerDraft

    • of

      static McpServerDraft of(McpServerDraft template)
      factory method to create a shallow copy McpServerDraft
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      McpServerDraft copyDeep()

    • deepCopy

      @Nullable static McpServerDraft deepCopy(@Nullable McpServerDraft template)
      factory method to create a deep copy of McpServerDraft
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static McpServerDraftBuilder builder()
      builder factory method for McpServerDraft
      Returns:
      builder

    • builder

      static McpServerDraftBuilder builder(McpServerDraft template)
      create builder for McpServerDraft instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withMcpServerDraft

      default <T> T withMcpServerDraft(Function<McpServerDraft,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<McpServerDraft> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference