Class ServerMcpApi

java.lang.Object
com.github.copilot.generated.rpc.ServerMcpApi
@Generated("copilot-sdk-codegen") public final class ServerMcpApi extends Object
API methods for the mcp namespace.
Since:
1.0.0

  • Field Details

    • config

      public final ServerMcpConfigApi config
      API methods for the mcp.config sub-namespace.

    • installations

      public final ServerMcpInstallationsApi installations
      API methods for the mcp.installations sub-namespace.

  • Method Details

    • discover

      @CopilotExperimental public CompletableFuture<McpDiscoverResult> discover(McpDiscoverParams params)
      Discovers MCP servers from user, workspace, plugin, and builtin sources.
      Since:
      1.0.0

    • planInstall

      @CopilotExperimental public CompletableFuture<McpPlanInstallResult> planInstall(McpPlanInstallParams params)
      Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with planning available returns a normalised plan and opaque single-use plan handle; a runtime without it returns the typed planning-unavailable result. A completed plan reports resource identity, provenance, eligible transport choices, the user-scope target, required typed values and secret placeholders, the policy result, the configuration changes installing would make, and whether a reload would be needed. Planning never writes configuration, stores a secret, or reloads MCP servers, so abandoning a plan needs no call and leaves nothing behind.
      Since:
      1.0.0

    • planInstall

      @CopilotExperimental public CompletableFuture<McpPlanInstallResult> planInstall(McpPlanInstallRequest request)
      Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card. This host-implemented server method is available through SDK/TUI hosts; standalone and C-ABI runtimes whose host does not implement server-method dispatch return JSON-RPC MethodNotFound. A runtime with planning available returns a normalised plan and opaque single-use plan handle; a runtime without it returns the typed planning-unavailable result. A completed plan reports resource identity, provenance, eligible transport choices, the user-scope target, required typed values and secret placeholders, the policy result, the configuration changes installing would make, and whether a reload would be needed. Planning never writes configuration, stores a secret, or reloads MCP servers, so abandoning a plan needs no call and leaves nothing behind.

      Accepts the extensible request, including inputs added after the params record.

      Since:
      1.0.0

    • prepareInstall

      @CopilotExperimental public CompletableFuture<McpInstallationManagementResult> prepareInstall(McpPrepareInstallParams params)
      Consumes a bound catalogue plan and retains one exact fully resolved personal remote MCP operation requiring no supplied values or configured secrets. Returns its runtime operation ID and original expiry before any confirmation, activation, writer initialisation or installation effect. Register the original connection, operation and selected-session binding before calling applyInstall. Missing lower owned admission is unavailable, never a raw-config fallback.
      Since:
      1.0.0

    • applyInstall

      @CopilotExperimental public CompletableFuture<McpInstallationResult> applyInstall(McpApplyInstallParams params)
      Consumes a retained prepared MCP operation once, revalidates its original authority, requests explicit human consent through installations.confirm on the original connection, then revalidates source and applies the sealed transaction. An uncertain result requires original-operation inspection or recovery, never replay.
      Since:
      1.0.0

    • planUninstall

      @CopilotExperimental public CompletableFuture<McpInstallationManagementResult> planUninstall(McpPlanUninstallParams params)
      Prepares a read-only removal plan for an exact owned receipt under the selected existing session. Returns the original operation ID before confirmation; neither planning nor abandonment changes configuration or shared OAuth credentials.
      Since:
      1.0.0

    • applyUninstall

      @CopilotExperimental public CompletableFuture<McpInstallationResult> applyUninstall(McpApplyUninstallParams params)
      Consumes the original owned-removal plan once and requests fresh exact human confirmation on its original connection. Drift is refused; unrelated manual configuration and shared OAuth credentials are preserved.
      Since:
      1.0.0