Class ServerCatalogApi

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

  • Method Details

    • search

      @CopilotExperimental public CompletableFuture<CatalogSearchResult> search(CatalogSearchParams params)
      Requests a bounded catalog search. 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 search available returns inert candidate summaries, each with an opaque single-use handle scoped to this runtime instance; a runtime without it returns the typed search-unavailable result. Public authorities may be searched anonymously, while an authority that requires credentials yields the typed authentication-required result. All returned text, URLs, and package metadata are untrusted external data and can never trigger instructions, tools, or installation. Read-only: nothing is installed, configured, or persisted.
      Since:
      1.0.0

    • search

      @CopilotExperimental public CompletableFuture<CatalogSearchResult> search(CatalogSearchRequest request)
      Requests a bounded catalog search. 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 search available returns inert candidate summaries, each with an opaque single-use handle scoped to this runtime instance; a runtime without it returns the typed search-unavailable result. Public authorities may be searched anonymously, while an authority that requires credentials yields the typed authentication-required result. All returned text, URLs, and package metadata are untrusted external data and can never trigger instructions, tools, or installation. Read-only: nothing is installed, configured, or persisted.

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

      Since:
      1.0.0

    • select

      @CopilotExperimental public CompletableFuture<CatalogSelectionResult> select(CatalogSelectParams params)
      Terminates one retained catalog selection group. A selected outcome returns the native host a fresh single-use candidate handle plus the original searchId for a later explicit mcp.planInstall call; non-selected outcomes release the group without producing a planning input. Candidate state, cards, URLs, credentials and private identifiers remain inside the runtime. The model-facing catalog_select tool projects the result separately and never exposes the candidate handle or searchId.
      Since:
      1.0.0