Class McpPlanInstallRequest

java.lang.Object
com.github.copilot.generated.rpc.McpPlanInstallRequest
@CopilotExperimental @Generated("copilot-sdk-codegen") public final class McpPlanInstallRequest extends Object
A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers.

Required inputs are constructor arguments. Optional inputs have fluent setters.

Since:
1.0.0

  • Constructor Details

    • McpPlanInstallRequest

      public McpPlanInstallRequest(CatalogClientContract contract, Object source)
      Creates a request with its required inputs.
      Parameters:
      contract - Protocol version and capabilities the caller requires.
      source - What to plan: either a candidate handle from a previous search, or a card supplied directly.

  • Method Details

    • getContract

      public CatalogClientContract getContract()
      Returns the contract property.
      Returns:
      Protocol version and capabilities the caller requires.

    • getSource

      public Object getSource()
      Returns the source property.
      Returns:
      What to plan: either a candidate handle from a previous search, or a card supplied directly.

    • getScope

      public McpPlanScope getScope()
      Returns the scope property.
      Returns:
      Configuration scope the plan targets. Defaults to user scope when omitted.

    • getPolicySessionId

      public String getPolicySessionId()
      Returns the policySessionId property.
      Returns:
      The same existing attached session that owns the original catalogue candidate.

    • setScope

      public McpPlanInstallRequest setScope(McpPlanScope value)
      Sets the scope property.
      Parameters:
      value - Configuration scope the plan targets. Defaults to user scope when omitted.
      Returns:
      this request

    • setPolicySessionId

      public McpPlanInstallRequest setPolicySessionId(String value)
      Sets the policySessionId property.
      Parameters:
      value - The same existing attached session that owns the original catalogue candidate.
      Returns:
      this request