@github/copilot-sdk-win32-x64 1.0.17-preview.4 → 1.0.17-preview.6

package/copilot-sdk/client.d.ts

@@ -507,6 +507,7 @@ export declare class CopilotClient {
     private handleUserInputRequest;
     private handleExitPlanModeRequest;
     private handleAutoModeSwitchRequest;
+    private resolveSkillProviderSession;
     private handleHooksInvoke;
     private handleSystemMessageTransform;
 }

package/copilot-sdk/extension.d.ts

@@ -2,7 +2,7 @@ import type { CopilotSession } from "./session.js";
 import { type PermissionHandler, type ResumeSessionConfig } from "./types.js";
 import type { WorkflowHandle } from "./workflow.js";
 export { Canvas, CanvasError, createCanvas, type CanvasAction, type CanvasDeclaration, type CanvasHostContext, type CanvasJsonSchema, type CanvasOptions, } from "./canvas.js";
-export type JoinSessionConfig = Omit<ResumeSessionConfig, "onPermissionRequest" | "extensionSdkPath"> & {
+export type JoinSessionConfig = Omit<ResumeSessionConfig, "onPermissionRequest" | "extensionSdkPath" | "skillProvider"> & {
     onPermissionRequest?: PermissionHandler;
     /**
      * Names of sensitive environment variables this extension needs, such as

package/copilot-sdk/extension.js

@@ -5004,6 +5004,37 @@ function createServerRpc(connection) {
        * @returns Outcome of an agentRegistry.spawn call.
        */
       spawn: async (params) => connection.sendRequest("agentRegistry.spawn", params)
+    },
+    /** @experimental */
+    connectors: {
+      /**
+       * Returns feature availability.
+       *
+       * @returns Feature availability.
+       */
+      getCapabilities: async () => connection.sendRequest("connectors.getCapabilities", {}),
+      /**
+       * Returns eligible accounts.
+       *
+       * @returns Eligible accounts.
+       */
+      getAccounts: async () => connection.sendRequest("connectors.getAccounts", {}),
+      /**
+       * Lists entries for the selected account.
+       *
+       * @param params Selected account.
+       *
+       * @returns Entries for the selected account.
+       */
+      list: async (params) => connection.sendRequest("connectors.list", params),
+      /**
+       * Refreshes entries for the selected account.
+       *
+       * @param params Selected account.
+       *
+       * @returns Entries for the selected account.
+       */
+      refresh: async (params) => connection.sendRequest("connectors.refresh", params)
     }
   };
 }
@@ -5059,6 +5090,110 @@ function createInternalServerRpc(connection) {
      */
     connect: async (params) => connection.sendRequest("connect", params),
     /** @experimental */
+    agents: {
+      /**
+       * Lists the agents this runtime ships, by name. A consumer separating shipped agents from ones the user or a plugin authored should compare against these names rather than against `AgentInfo.source`: an authored agent may carry the `builtin` source while not being one of these, and the runtime treats the two as separate questions. `disableableNames` is the subset a user may turn off, which a client needs to decide whether to offer a toggle. `yamlBasedNames` is the subset backed by a shipped YAML definition, which a client needs before asking the runtime to load one.
+       *
+       * @returns The agents this runtime ships, named so a consumer can tell them apart from authored ones.
+       */
+      getBuiltins: async () => connection.sendRequest("agents.getBuiltins", {}),
+      /**
+       * Lists the shipped agents a client should offer right now, filtered by the feature flags it passes. `getBuiltins` names every agent the runtime knows about; some of those are gated, so a client rendering a picker wants this narrower list together with the description to show beside each name.
+       *
+       * @param params The feature flags to evaluate shipped agents against.
+       *
+       * @returns The shipped agents available under the requested flags.
+       */
+      getAvailableBuiltins: async (params) => connection.sendRequest("agents.getAvailableBuiltins", params),
+      /**
+       * Loads one shipped agent's YAML definition, for a client that needs what the agent declares rather than only its name. `getBuiltins` reports which names have a definition to load: a name outside its `yamlBasedNames` is special-cased in code and has none. The definition crosses as its own JSON rather than as contract-typed fields, because the runtime parses it with the agent schema's tolerant shape and re-typing it here would drop the keys that shape accepts and this one does not. The projected `__nativeCustomAgent` view the runtime derives is included, so a caller reading the declared model and a caller rendering the agent see the same definition.
+       *
+       * @param params The shipped agent whose definition to load.
+       *
+       * @returns One shipped agent's definition.
+       */
+      getBuiltinDefinition: async (params) => connection.sendRequest("agents.getBuiltinDefinition", params),
+      /**
+       * Projects one shipped agent the way a picker lists it, reading only the metadata at the head of the definition file and stopping before the prompt body. `getBuiltinDefinition` answers the whole definition instead, so a client listing every shipped agent should prefer this one: the cost of a listing grows with the number of agents, and the prompt body is the part a listing never shows. The two also differ in shape. This returns the projected custom agent on its own, whereas `getBuiltinDefinition` returns the authored definition with that projection nested under `__nativeCustomAgent`.
+       *
+       * @param params The shipped agent whose listing entry to load.
+       *
+       * @returns One shipped agent, projected for a listing.
+       */
+      getBuiltinListingDefinition: async (params) => connection.sendRequest("agents.getBuiltinListingDefinition", params),
+      /**
+       * Resolves the model a custom agent asks for against the models actually available, and answers both the model to switch to and the warning a user should see when the agent's preference cannot be met. A custom agent may name several acceptable models in preference order, so the decision is a match rather than a lookup, and an agent whose preference is unavailable is a normal outcome that produces a warning rather than an error. A host must call this rather than pick the first available name itself, because the preference order and the wording of the warning are what keep one installation's agent selection the same as another's.
+       *
+       * @param params The models a custom agent asks for, and the models actually available.
+       *
+       * @returns The model to switch to, and the warning to show when the agent's preference could not be met.
+       */
+      customAgentInitialModelDecision: async (params) => connection.sendRequest("agents.customAgentInitialModelDecision", params)
+    },
+    /** @experimental */
+    gitHubRepository: {
+      /**
+       * Resolves the GitHub repository that owns a working-tree path by reading the selected git remote configured for it, preferring `origin`. Returns a null `repository` when the path is inside a git working tree but that selected remote does not resolve to a GitHub host. Fails when the path is not inside a git working tree at all, so a caller can tell 'not a repository' apart from 'a repository with no GitHub remote'.
+       *
+       * @param params Working-tree path whose owning GitHub repository should be resolved.
+       *
+       * @returns The GitHub repository that owns the requested path, when the selected remote (`origin`, else the first) is on a GitHub host.
+       */
+      atPath: async (params) => connection.sendRequest("gitHubRepository.atPath", params)
+    },
+    /** @experimental */
+    gitHubOwners: {
+      /**
+       * Registers a cancellable owner listing and returns its request id. Separate from `gitHubOwners.list` so the id exists before the listing starts: a caller that abandons the listing the moment it begins would otherwise have nothing to name in `gitHubOwners.cancel`. The id serves one listing only. Long-abandoned unused ids can be released by later allocations.
+       *
+       * @returns A freshly registered request id. Registering it before the listing starts is what lets a cancel that races the request still find the owner listing slot. The id serves one listing only. Long-abandoned unused ids can be released by later allocations.
+       */
+      nextRequestId: async () => connection.sendRequest("gitHubOwners.nextRequestId", {}),
+      /**
+       * Lists the logins the authenticated user may act as — their own account first, then the organizations they belong to — by asking the GitHub API under the supplied credential. No credential travels in the request: `authInfo` selects one the runtime already holds, and the runtime resolves the token and the GitHub host from it. A failure the caller should render arrives as `message`; one it should raise arrives as `throwError`.
+       *
+       * @param params Credential to list owners under, and the request id that makes the listing cancellable.
+       *
+       * @returns Outcome of an owner listing. Exactly one of `owners` and `message` is present, except that `throwError` reports a failure the caller is expected to raise rather than render.
+       */
+      list: async (params) => connection.sendRequest("gitHubOwners.list", params),
+      /**
+       * Abandons an owner listing started with the given request id. Answers `canceled: true` while a listing with that id is running. Answers `canceled: false` when the id was never registered, was registered but not used, was released after being abandoned, or its listing has ended. Canceling an unused id releases it, and a later `list` with that id is refused. The cancel acts only on owner listings and never reaches another request of the host.
+       *
+       * @param params The owner listing to abandon.
+       *
+       * @returns Whether the id named a running owner listing.
+       */
+      cancel: async (params) => connection.sendRequest("gitHubOwners.cancel", params)
+    },
+    /** @experimental */
+    git: {
+      /**
+       * Reads the remote that the branch checked out in a working tree tracks, as `branch.<name>.remote` configures it. Reports `origin` rather than failing whenever there is no tracking configuration to read — on a detached HEAD, on a branch with no upstream, or when git itself fails — because a caller asking which remote to talk to needs an answer it can act on, not an error. Marked internal because it exists to carry a CLI call site off the napi boundary onto the SDK contract; it is migration plumbing, not a surface consumers are meant to depend on.
+       *
+       * @param params Working-tree path a git query applies to.
+       *
+       * @returns The remote the checked-out branch tracks.
+       */
+      currentBranchRemote: async (params) => connection.sendRequest("git.currentBranchRemote", params),
+      /**
+       * Collects the repository context of a working directory in one call: working tree root, repository identifier and host, current branch, and the HEAD and base commits. Every repository field is omitted when the path is not inside a git working tree, and the requested path is echoed back as `cwd`. The answer is the same `SessionWorkingDirectoryContext` that `session.metadata.recordContextChange` accepts, so a caller polling for a context change can forward the result unchanged. Marked internal because it exists to carry a CLI call site off the napi boundary onto the SDK contract; it is migration plumbing, not a surface consumers are meant to depend on. It can become public once an SDK consumer needs to derive session context from a directory itself.
+       *
+       * @param params Working-tree path a git query applies to.
+       *
+       * @returns Updated working directory and git context. Emitted as the new payload of `session.context_changed`.
+       */
+      workingDirectoryContext: async (params) => connection.sendRequest("git.workingDirectoryContext", params),
+      /**
+       * Lists the GitHub repositories a working tree's remotes point at, one entry per distinct repository, so a caller can resolve a base and head repository without parsing remote URLs itself. When several remotes name the same repository, only the first is listed, and the entry keeps that remote name. Remotes pointing at no GitHub host are left out, so an empty list means the tree reaches GitHub through no remote. Failing to read the remotes is reported as an error rather than as an empty list, because the two mean different things to a caller. Marked internal because it exists to carry a CLI call site off the napi boundary onto the SDK contract; it is migration plumbing, not a surface consumers are meant to depend on.
+       *
+       * @param params Git working tree whose GitHub remotes should be listed.
+       *
+       * @returns The GitHub repositories a working tree's remotes point at.
+       */
+      reposFromRemotes: async (params) => connection.sendRequest("git.reposFromRemotes", params)
+    },
+    /** @experimental */
     sessions: {
       /**
        * Reads lightweight persisted metadata for one local session without opening it.
@@ -5098,6 +5233,30 @@ function createInternalServerRpc(connection) {
        * @param params Session ID to delete from disk.
        */
       delete: async (params) => connection.sendRequest("sessions.delete", params),
+      /**
+       * Creates the workspace record for a session that has not been opened yet. A host that hands a session off to another application — writing the record and then launching that application against the session ID — needs the record on disk before any session exists to carry it, which the session-scoped workspace methods cannot do. Replaces any existing record and resets the checkpoint index. When writing to the local filesystem, a stored `fork_count` survives on disk. Returns the record it built, so a surviving stored `fork_count` can differ from the answer.
+       *
+       * @param params Identity, state location and starting context for a workspace record.
+       *
+       * @returns The workspace record that was written.
+       */
+      createWorkspace: async (params) => connection.sendRequest("sessions.createWorkspace", params),
+      /**
+       * Reads a session's workspace record straight from disk, without opening the session. Resuming by session ID has to know where the session lives before it can connect, so the lookup cannot come from the session-scoped workspace methods, which resolve their location from a live session's context. Returns no record when the file is absent.
+       *
+       * @param params Where the session's state lives, as a root directory and the session ID under it.
+       *
+       * @returns The workspace record on disk, omitted when the session has none.
+       */
+      loadWorkspace: async (params) => connection.sendRequest("sessions.loadWorkspace", params),
+      /**
+       * Merges fields into a session's workspace record on disk, creating the record when it is absent. The counterpart to `sessions.loadWorkspace`, for the same before-the-session-exists case. It preserves stored workspace-schema fields the request does not supply, does not preserve stored keys outside the workspace schema, and never replaces a stored `fork_count`.
+       *
+       * @param params Where the session's state lives, plus workspace-schema fields to merge into its workspace record. Stored keys outside the schema are not preserved, and a stored `fork_count` is never replaced.
+       *
+       * @returns The merge completed. The record carries the supplied workspace-schema fields, but a stored `fork_count` stays.
+       */
+      updateWorkspaceFields: async (params) => connection.sendRequest("sessions.updateWorkspaceFields", params),
       /**
        * Gets the dynamic-context board entry count associated with a session, when available. Internal: this exists solely so CLI telemetry events (`rem_spawn_gate`, `rem_consolidation_complete`) can pair START / END board counts around the detached rem-agent spawn. "Dynamic context board" is a runtime-internal concept that is not part of the public SDK contract; the long-term plan is to relocate the telemetry emission into the runtime so this method can be deleted entirely.
        *
@@ -5972,11 +6131,17 @@ function createSessionRpc(connection, sessionId) {
     /** @experimental */
     mcp: {
       /**
-       * Lists MCP servers configured for the session, their connection status, and host-level state. The host-level state (disabled/filtered servers, failed/needs-auth/pending connections, mcp3p policy, full config) is empty/zero when no MCP host has been initialized for the session.
+       * Lists materialized MCP servers and their connection status. Cache misses may start and wait for MCP servers.
        *
        * @returns MCP servers configured for the session, with their connection status and host-level state.
        */
       list: async () => connection.sendRequest("session.mcp.list", { sessionId }),
+      /**
+       * Lists effective MCP configuration without starting, restarting, authenticating, or waiting for servers. An optional live observation is from an already materialized matching server; this is not a readiness guarantee.
+       *
+       * @returns Effective MCP configuration with optional live observations from matching already materialized servers.
+       */
+      listConfigured: async () => connection.sendRequest("session.mcp.listConfigured", { sessionId }),
       /**
        * Lists the tools exposed by a connected MCP server on this session's host. This performs a live `tools/list` request. Tool UI metadata is returned independently of whether MCP Apps rendering is enabled for the session.
        *
@@ -7425,6 +7590,12 @@ function createInternalSessionRpc(connection, sessionId) {
     },
     /** @experimental */
     mcp: {
+      /**
+       * Records the IDE the host is connected to, so the agent's system prompt can name it and its workspace folder. Null or an omitted `ide` clears the recorded value, which is how a host reports that it is disconnected; there is no separate clear method. Both `ideName` and `workspaceFolder` are required together, because half a state cannot be attributed to a project.
+       *
+       * @param params Records which IDE the host is connected to, or clears it.
+       */
+      setConnectedIdeInfo: async (params) => connection.sendRequest("session.mcp.setConnectedIdeInfo", { ...params, sessionId }),
       /**
        * Reloads MCP server connections for the session with an explicit host-provided configuration.
        *
@@ -9196,6 +9367,7 @@ var CopilotSession = class {
   elicitationHandler;
   exitPlanModeHandler;
   autoModeSwitchHandler;
+  skillProvider;
   hooks;
   transformCallbacks;
   _rpc = null;
@@ -9608,6 +9780,7 @@ var CopilotSession = class {
     this.elicitationHandler = void 0;
     this.exitPlanModeHandler = void 0;
     this.autoModeSwitchHandler = void 0;
+    this.skillProvider = void 0;
     this.commandHandlers.clear();
     this.canvases.clear();
     this.workflows.clear();
@@ -10514,6 +10687,68 @@ var CopilotSession = class {
   registerUserInputHandler(handler) {
     this.userInputHandler = handler;
   }
+  /**
+   * Registers the session's skill provider.
+   *
+   * @param provider - The skill provider, or undefined to remove it
+   * @internal This method is typically called internally when creating a session.
+   */
+  registerSkillProvider(provider) {
+    this.skillProvider = provider;
+  }
+  /**
+   * Handles a `skillProvider.list` request from the runtime.
+   *
+   * @internal This method is for internal use by the SDK.
+   */
+  async _handleSkillProviderList(token) {
+    const provider = this.requireSkillProvider();
+    return await this.callSkillProvider("listSkills", token, async (options) => ({
+      skills: await provider.listSkills(options) ?? []
+    }));
+  }
+  /**
+   * Handles a `skillProvider.read` request from the runtime.
+   *
+   * @internal This method is for internal use by the SDK.
+   */
+  async _handleSkillProviderRead(name, token) {
+    const provider = this.requireSkillProvider();
+    return await this.callSkillProvider("readSkill", token, async (options) => ({
+      markdown: await provider.readSkill(name, options) ?? null
+    }));
+  }
+  requireSkillProvider() {
+    if (!this.skillProvider) {
+      throw new Error(`No skill provider for session: ${this.sessionId}`);
+    }
+    return this.skillProvider;
+  }
+  /**
+   * Runs a provider call with an abort signal tied to the runtime's request
+   * cancellation. Failures are logged locally and reported generically.
+   */
+  async callSkillProvider(operation, token, call) {
+    const controller = new AbortController();
+    const subscription = token?.onCancellationRequested(() => controller.abort());
+    if (token?.isCancellationRequested) {
+      controller.abort();
+    }
+    try {
+      return await call({ signal: controller.signal });
+    } catch (error) {
+      if (controller.signal.aborted) {
+        throw new import_node.ResponseError(-32800, `Skill provider ${operation} cancelled`);
+      }
+      console.error(`Skill provider ${operation} failed`, {
+        sessionId: this.sessionId,
+        error
+      });
+      throw skillProviderFailure(operation);
+    } finally {
+      subscription?.dispose();
+    }
+  }
   /**
    * Registers hook handlers for session lifecycle events.
    *
@@ -10867,6 +11102,9 @@ function toCanvasRpcError(error) {
   const message = error instanceof Error ? error.message : String(error);
   return new import_node.ResponseError(import_node.ErrorCodes.InternalError, message, { code, message });
 }
+function skillProviderFailure(operation) {
+  return new import_node.ResponseError(import_node.ErrorCodes.InternalError, `Skill provider ${operation} failed`);
+}
 function strictJsonValidationError(context, category, message, path) {
   return new import_node.ResponseError(import_node.ErrorCodes.InternalError, message, {
     code: context.code,
@@ -12548,6 +12786,9 @@ var CopilotClient = class _CopilotClient {
     if (config.gitHubToken !== void 0 && config.gitHubTokenProvider !== void 0) {
       throw new Error("gitHubToken and gitHubTokenProvider are mutually exclusive");
     }
+    if (config.cloud != null && config.skillProvider) {
+      throw new Error("Skill providers are not supported for cloud sessions.");
+    }
     if (!this.connection) {
       await this.start();
     }
@@ -12607,6 +12848,9 @@ var CopilotClient = class _CopilotClient {
       if (config.hooks) {
         s.registerHooks(config.hooks);
       }
+      if (config.skillProvider) {
+        s.registerSkillProvider(config.skillProvider);
+      }
       if (transformCallbacks) {
         s.registerTransformCallbacks(transformCallbacks);
       }
@@ -12713,6 +12957,7 @@ var CopilotClient = class _CopilotClient {
         enableSessionStore: config.enableSessionStore,
         enableSkills: config.enableSkills,
         skillDirectories: config.skillDirectories,
+        ...config.skillProvider ? { hasSkillProvider: true } : {},
         pluginDirectories: config.pluginDirectories,
         instructionDirectories: config.instructionDirectories,
         disabledSkills: config.disabledSkills,
@@ -12866,6 +13111,9 @@ var CopilotClient = class _CopilotClient {
     if (config.hooks) {
       session.registerHooks(config.hooks);
     }
+    if (config.skillProvider) {
+      session.registerSkillProvider(config.skillProvider);
+    }
     const modeDefaults = this.configDefaultsForMode();
     config = { ...modeDefaults, ...config };
     config.customAgentsLocalOnly ??= modeDefaults.customAgentsLocalOnly;
@@ -12879,9 +13127,10 @@ var CopilotClient = class _CopilotClient {
     if (config.onEvent) {
       session.on(config.onEvent);
     }
+    const toolFilterOptions = this.resolveToolFilterOptions(config);
     this.setupSessionFs(session, config);
+    const replacedSession = this.sessions.get(sessionId);
     this.sessions.set(sessionId, session);
-    const toolFilterOptions = this.resolveToolFilterOptions(config);
     const gitHubTokenProviderRegistrationId = this.registerGitHubTokenProvider(
       config.gitHubTokenProvider,
       sessionId
@@ -12974,6 +13223,7 @@ var CopilotClient = class _CopilotClient {
         defaultAgent: config.defaultAgent,
         agent: config.agent,
         skillDirectories: config.skillDirectories,
+        ...config.skillProvider ? { hasSkillProvider: true } : {},
         pluginDirectories: config.pluginDirectories,
         instructionDirectories: config.instructionDirectories,
         disabledSkills: config.disabledSkills,
@@ -13018,7 +13268,13 @@ var CopilotClient = class _CopilotClient {
       this.commitGitHubTokenProvider(sessionId, gitHubTokenProviderRegistrationId);
     } catch (e) {
       session._markDisconnected();
-      this.sessions.delete(sessionId);
+      if (this.sessions.get(sessionId) === session) {
+        if (replacedSession) {
+          this.sessions.set(sessionId, replacedSession);
+        } else {
+          this.sessions.delete(sessionId);
+        }
+      }
       if (gitHubTokenProviderRegistrationId !== void 0) {
         this.githubTokenProviders.delete(gitHubTokenProviderRegistrationId);
       }
@@ -13994,6 +14250,20 @@ stderr: ${stderrOutput}` : ""}`
         return await this.handleHooksInvoke(params);
       }
     );
+    this.connection.onRequest(
+      "skillProvider.list",
+      async (params, token) => await this.resolveSkillProviderSession(params)._handleSkillProviderList(token)
+    );
+    this.connection.onRequest(
+      "skillProvider.read",
+      async (params, token) => {
+        const session = this.resolveSkillProviderSession(params);
+        if (typeof params.name !== "string") {
+          throw new Error("Invalid skillProvider.read payload");
+        }
+        return await session._handleSkillProviderRead(params.name, token);
+      }
+    );
     const connection = this.connection;
     const messageWriter = this.messageWriter;
     const cliProcess = this.isExternalServer ? null : this.cliProcess;
@@ -14150,6 +14420,16 @@ stderr: ${stderrOutput}` : ""}`
     });
     return { response };
   }
+  resolveSkillProviderSession(params) {
+    if (!params || typeof params.sessionId !== "string") {
+      throw new Error("Invalid skillProvider payload");
+    }
+    const session = this.sessions.get(params.sessionId);
+    if (!session) {
+      throw new Error(`Session not found: ${params.sessionId}`);
+    }
+    return session;
+  }
   async handleHooksInvoke(params) {
     if (!params || typeof params.sessionId !== "string" || typeof params.hookType !== "string") {
       throw new Error("Invalid hooks invoke payload");
@@ -14184,11 +14464,13 @@ async function joinSession(config = {}) {
   const client = new CopilotClient({ _internalConnection: { kind: "parent-process" } });
   const {
     extensionSdkPath: _stripped,
+    skillProvider: _strippedSkillProvider,
     workflows,
     requestedEnvironmentVariables,
     ...rest
   } = config;
   void _stripped;
+  void _strippedSkillProvider;
   return client.resumeSessionForExtension(
     sessionId,
     {