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

    • getSavedFeed

      @CopilotExperimental public CompletableFuture<CatalogResourceSavedFeedResult> getSavedFeed(CatalogGetSavedFeedParams params)
      Retrieves one saved feed by its opaque ID, optionally filtered by trust tier. Requires catalog-feeds and catalog-search-credential-required, and uses the same authority, credential policy, optional session binding and candidate projection as catalog.search, so available entries are the same inert candidates, with the same installability, handles and display metadata, and install through the same confirmed flows. Entries keep the feed's order; an entry the runtime cannot present is returned as unavailable with a reason rather than failing the feed. No anonymous retry. Read-only: nothing is installed, configured, or persisted.
      Since:
      1.0.0

    • getGeneratedFeed

      @CopilotExperimental public CompletableFuture<CatalogResourceGeneratedFeedResult> getGeneratedFeed(CatalogGetGeneratedFeedParams params)
      Retrieves one generated feed by strategy and key, such as telemetry/popular, optionally filtered by trust tier. Requires catalog-feeds and catalog-search-credential-required, and uses the same authority, credential policy, optional session binding and candidate projection as catalog.search, so available entries are the same inert candidates, with the same installability, handles and display metadata, and install through the same confirmed flows. Entries keep the feed's order; an entry the runtime cannot present is returned as unavailable with a reason rather than failing the feed. No anonymous retry. Read-only: nothing is installed, configured, or persisted.
      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

    • planInstallFromReference

      @CopilotExperimental public CompletableFuture<CatalogReferenceInstallationResult> planInstallFromReference(CatalogPlanInstallFromReferenceParams params)
      Plans installing the resource an Agent Finder materialisation reference pins, without writing files and whatever its kind. The runtime retrieves the descriptor once, only from its fixed Agent Finder authority, verifies it, and plans by its resolution policy: a Skill (`agent-skill@1.0.0`) when the caller requires skill-confirmed-installation, an Agent Plugin (`plugin@1.0.0`) when it requires agent-plugin-confirmed-installation. Any other kind is refused as unsupported-resource. The outcome names the kind; apply a Skill plan with skills.applyInstall and an Agent Plugin plan with plugins.applyInstall. The review shows only verified data.
      Since:
      1.0.0