@adecore/agents 0.31.4 → 0.31.5

package/src/providers/acp-agent-state.ts

@@ -0,0 +1,206 @@
+import { ModelOptionDescriptorSchema, type ModelOptionDescriptor, type ProviderCapabilities } from '@adecore/agent-contracts';
+import { z } from 'zod';
+import type { AcpSessionInfo } from '../chat/acp-protocol.ts';
+import type { ModelCatalog } from './catalog.ts';
+
+/* Where a provider keeps what its agent reported, so a host that starts again offers it before the agent runs. The value is the provider's own. */
+export interface AcpCatalogStore {
+    load(): unknown;
+    save(value: unknown): void;
+}
+
+const AdoptedSchema = z.object({
+    defaultModel: z.string().min(1),
+    models: z.array(z.object({ slug: z.string().min(1), name: z.string(), contextWindow: z.number().int().positive().optional() })).min(1),
+    options: z.array(ModelOptionDescriptorSchema)
+});
+
+type Adopted = z.infer<typeof AdoptedSchema>;
+
+/* An agent's model id may reach a command line, so one that reads as a flag is left out. */
+function adoptableModels(info: AcpSessionInfo): Adopted['models'] {
+    return (info.models?.models ?? [])
+        .filter((model) => model.id !== '' && !model.id.startsWith('-'))
+        .map((model) => ({ slug: model.id, name: model.name, ...(model.contextWindow === null ? {} : { contextWindow: model.contextWindow }) }));
+}
+
+/* The reasoning effort a session offers, as the `effort` option the composer draws for every provider. */
+function effortOption(info: AcpSessionInfo): ModelOptionDescriptor[] {
+    const level = info.thoughtLevel;
+    if (level === null || !level.choices.some((choice) => choice.id === level.current)) {
+        return [];
+    }
+    return [
+        {
+            id: 'effort',
+            label: 'Reasoning',
+            type: 'select',
+            defaultChoice: level.current,
+            choices: level.choices.map((choice) => ({
+                id: choice.id,
+                label: choice.name,
+                ...(choice.description === null ? {} : { description: choice.description })
+            }))
+        }
+    ];
+}
+
+/* Parses one stored part on its own, so a part a later version wrote differently costs only that part. */
+function storedPart<T>(schema: z.ZodType<T>, value: unknown): T | null {
+    const parsed = schema.safeParse(value);
+    return parsed.success ? parsed.data : null;
+}
+
+export interface AcpAgentStateOptions {
+    catalog: ModelCatalog;
+    adoptModels: boolean;
+    store: AcpCatalogStore | null;
+    // The capabilities the provider reports before what the agent said is laid over them.
+    base: ProviderCapabilities;
+    // What the host set itself, which wins over what the agent said.
+    overrides: Partial<ProviderCapabilities>;
+}
+
+/*
+ * What an agent reported about itself, outside any one session: the models it offers and what follows from it for the
+ * provider's capabilities. Kept in the host's store when it has one, and every change is told to the listeners, so a host
+ * can hand its clients the new list.
+ */
+export class AcpAgentState {
+    // Changed in place, so a host that spread the provider into a value of its own reads the same object.
+    readonly capabilities: ProviderCapabilities;
+    private readonly options: AcpAgentStateOptions;
+    private readonly listeners = new Set<() => void>();
+    private adopted: Adopted | null = null;
+    // Whether the agent reported its context window in a `usage_update`, once in any session.
+    private reportsContext = false;
+    // The slash commands the last session listed; null until one did.
+    private commands: string[] | null = null;
+
+    constructor(options: AcpAgentStateOptions) {
+        this.options = options;
+        this.capabilities = { ...options.base, ...options.overrides };
+        this.restore();
+    }
+
+    onChange(listener: () => void): () => void {
+        this.listeners.add(listener);
+        return () => {
+            this.listeners.delete(listener);
+        };
+    }
+
+    session(info: AcpSessionInfo): void {
+        if (!this.options.adoptModels || info.models === null) {
+            return;
+        }
+        const adopted: Adopted = { defaultModel: info.models.current, models: adoptableModels(info), options: effortOption(info) };
+        const changed = this.adopt(adopted);
+        this.settle(changed);
+    }
+
+    commandsListed(commands: readonly string[]): void {
+        const names = [...new Set(commands)].sort();
+        if (this.commands !== null && JSON.stringify(names) === JSON.stringify(this.commands)) {
+            return;
+        }
+        this.commands = names;
+        const changed = this.refresh();
+        // The commands are saved even when the capabilities stay, so a restart knows them too.
+        this.save();
+        if (changed) {
+            this.notify();
+        }
+    }
+
+    contextReported(): void {
+        if (this.reportsContext) {
+            return;
+        }
+        this.reportsContext = true;
+        this.settle(this.refresh());
+    }
+
+    private restore(): void {
+        let stored: unknown;
+        try {
+            stored = this.options.store?.load();
+        } catch {
+            return;
+        }
+        if (typeof stored !== 'object' || stored === null) {
+            return;
+        }
+        const record = stored as Record<string, unknown>;
+        const adopted = storedPart(AdoptedSchema, record.models);
+        if (adopted !== null && this.options.adoptModels) {
+            this.adopt(adopted);
+        }
+        this.reportsContext = record.reportsContext === true;
+        this.commands = storedPart(z.array(z.string()), record.commands);
+        this.refresh();
+    }
+
+    /* What the agent showed it can do, under what the host set itself. */
+    private learned(): Partial<ProviderCapabilities> {
+        const commands = this.commands ?? [];
+        return {
+            ...(this.reportsContext ? { reportsContextWindow: true } : {}),
+            ...(commands.includes('compact') ? { compaction: 'prompt' as const } : {}),
+            ...(commands.includes('goal') ? { goals: 'command' as const } : {})
+        };
+    }
+
+    /* Lays what the agent showed over the capabilities, in place; answers whether they changed. */
+    private refresh(): boolean {
+        const next: ProviderCapabilities = { ...this.options.base, ...this.learned(), ...this.options.overrides };
+        if (JSON.stringify(next) === JSON.stringify(this.capabilities)) {
+            return false;
+        }
+        const capabilities = this.capabilities as Partial<ProviderCapabilities>;
+        for (const key of Object.keys(capabilities) as Array<keyof ProviderCapabilities>) {
+            delete capabilities[key];
+        }
+        Object.assign(capabilities, next);
+        return true;
+    }
+
+    /* Answers whether the catalog changed; a list without its default is refused there and leaves the one adopted before. */
+    private adopt(adopted: Adopted): boolean {
+        if (!adopted.models.some((model) => model.slug === adopted.defaultModel)) {
+            return false;
+        }
+        this.adopted = adopted;
+        return this.options.catalog.adopt(adopted.models, adopted.defaultModel, adopted.options);
+    }
+
+    /* Saves and tells the listeners once something changed. */
+    private settle(changed: boolean): void {
+        if (changed) {
+            this.save();
+            this.notify();
+        }
+    }
+
+    private save(): void {
+        try {
+            this.options.store?.save(this.stored());
+        } catch {
+            // A store that cannot write costs the next start what it would have kept, never this session.
+        }
+    }
+
+    private notify(): void {
+        for (const listener of [...this.listeners]) {
+            listener();
+        }
+    }
+
+    private stored(): Record<string, unknown> {
+        return {
+            ...(this.adopted === null ? {} : { models: this.adopted }),
+            ...(this.reportsContext ? { reportsContext: true } : {}),
+            ...(this.commands === null ? {} : { commands: this.commands })
+        };
+    }
+}

package/src/providers/acp-provider.ts

@@ -1,15 +1,16 @@
-import type { AgentKind, ModelOptionDescriptor, ProviderCapabilities, ProviderInstall } from '@adecore/agent-contracts';
+import type { AgentKind, ProviderCapabilities, ProviderInstall } from '@adecore/agent-contracts';
 import { createAcpBackend, type AcpAgentSpec, type AcpUsageReport } from '../chat/acp-backend.ts';
 import type { AcpSessionInfo } from '../chat/acp-protocol.ts';
 import { askAcpAccount } from './accounts/acp-account.ts';
+import { AcpAgentState, type AcpCatalogStore } from './acp-agent-state.ts';
 import { writeAcpUsage } from './acp-usage-log.ts';
 import type { ModelCatalog } from './catalog.ts';
 import { detectCli, type CliDetection } from './detect.ts';
 import type { ChatProvider, ProviderHome } from './provider.ts';
 
 /*
- * What every ACP agent can do through this backend. A file change comes as the text before and after;
- * a message names its mentions and attachments by path, as text the agent opens with its own tools.
+ * What every ACP agent can do through this backend, before what it shows of itself. A file change comes as the text
+ * before and after; a message names its mentions and attachments by path, and carries the files themselves where the agent takes them.
  */
 export const ACP_CAPABILITIES: ProviderCapabilities = {
     chat: true,
@@ -36,7 +37,7 @@ export interface AcpProviderSpec extends AcpAgentSpec {
     command: string;
     args?: readonly string[];
     catalog: ModelCatalog;
-    // Over `ACP_CAPABILITIES`, for an agent that reports its cost or context window, or whose commands fold its context.
+    // Over `ACP_CAPABILITIES` and what the agent showed it can do, for what the host knows better.
     capabilities?: Partial<ProviderCapabilities>;
     // What a terminal runs to continue one of its sessions; empty where it has none.
     resumeCommand?: string;
@@ -56,45 +57,29 @@ export interface AcpProviderSpec extends AcpAgentSpec {
     adoptModels?: boolean;
     // The folder the usage of every turn the agent reports is logged to, for a usage root of the agent's kind; absent logs nothing.
     usageLog?: string;
+    // Keeps the models the agent reported across a restart of the host; absent starts from `catalog` every time.
+    catalogStore?: AcpCatalogStore;
 }
 
 /* Agents whose own usage files the scanner reads; a log of their turns would count every one twice. */
 const OWN_USAGE_FILES: ReadonlySet<AgentKind> = new Set(['grok']);
 
-/* An agent's model id may reach a command line, so one that reads as a flag is left out. */
-function adoptableModels(info: AcpSessionInfo): Array<{ slug: string; name: string }> {
-    return (info.models?.models ?? []).filter((model) => model.id !== '' && !model.id.startsWith('-')).map((model) => ({ slug: model.id, name: model.name }));
-}
-
-/* The reasoning effort a session offers, as the `effort` option the composer draws for every provider. */
-function effortOption(info: AcpSessionInfo): ModelOptionDescriptor[] {
-    const level = info.thoughtLevel;
-    if (level === null || !level.choices.some((choice) => choice.id === level.current)) {
-        return [];
-    }
-    return [
-        {
-            id: 'effort',
-            label: 'Reasoning',
-            type: 'select',
-            defaultChoice: level.current,
-            choices: level.choices.map((choice) => ({
-                id: choice.id,
-                label: choice.name,
-                ...(choice.description === null ? {} : { description: choice.description })
-            }))
-        }
-    ];
-}
-
 export function createAcpProvider(spec: AcpProviderSpec): ChatProvider {
-    const capabilities = { ...ACP_CAPABILITIES, ...spec.capabilities };
+    const state = new AcpAgentState({
+        catalog: spec.catalog,
+        adoptModels: spec.adoptModels !== false,
+        store: spec.catalogStore ?? null,
+        base: ACP_CAPABILITIES,
+        overrides: spec.capabilities ?? {}
+    });
     const onSession = (info: AcpSessionInfo): void => {
-        if (spec.adoptModels !== false && info.models !== null) {
-            spec.catalog.adopt(adoptableModels(info), info.models.current, effortOption(info));
-        }
+        state.session(info);
         spec.onSession?.(info);
     };
+    const onCommands = (commands: string[]): void => {
+        state.commandsListed(commands);
+        spec.onCommands?.(commands);
+    };
     const usageLog = spec.usageLog === undefined || OWN_USAGE_FILES.has(spec.kind) ? null : spec.usageLog;
     const onUsage =
         usageLog === null
@@ -107,7 +92,8 @@ export function createAcpProvider(spec: AcpProviderSpec): ChatProvider {
         kind: spec.kind,
         name: spec.name,
         catalog: spec.catalog,
-        capabilities,
+        capabilities: state.capabilities,
+        onChange: (listener) => state.onChange(listener),
         command: [spec.command, ...(spec.args ?? [])],
         resumeCommand: spec.resumeCommand ?? '',
         ...(spec.ignoresProjectConfig === undefined ? {} : { ignoresProjectConfig: spec.ignoresProjectConfig }),
@@ -131,9 +117,19 @@ export function createAcpProvider(spec: AcpProviderSpec): ChatProvider {
                           command,
                           env: { ...env, ...spec.env },
                           ...(spec.client ? { client: spec.client } : {}),
-                          onSession
+                          onSession,
+                          onCommands
                       })
               }),
-        createBackend: createAcpBackend({ ...spec, onSession, ...(onUsage === undefined ? {} : { onUsage }) })
+        createBackend: createAcpBackend({
+            ...spec,
+            onSession,
+            onCommands,
+            onContextReport: () => {
+                state.contextReported();
+                spec.onContextReport?.();
+            },
+            ...(onUsage === undefined ? {} : { onUsage })
+        })
     };
 }

package/src/providers/catalog.ts

@@ -18,6 +18,8 @@ function timeOf(data: ModelCatalogInput): number {
 export class ModelCatalog {
     private readonly shippedAt: number;
     private data: ModelCatalogInput;
+    // The sizes the host's own default had before an agent's models replaced it, for an adopted model that names none.
+    private hostWindows: ModelCatalogProfile['contextWindowTokens'] | undefined;
 
     constructor(data: ModelCatalogInput = manifest as never) {
         this.shippedAt = timeOf(data);
@@ -35,6 +37,7 @@ export class ModelCatalog {
         }
         const changed = JSON.stringify(data) !== JSON.stringify(this.data);
         this.data = data;
+        this.hostWindows = undefined;
         return changed;
     }
 
@@ -42,20 +45,31 @@ export class ModelCatalog {
      * Takes the models an agent reported for itself in place of the list, the agent's current model as the
      * default and its order kept; answers whether the models changed. Every model gets the profile the
      * default has now, as an agent names its models but not what each can be asked for, with `options`
-     * in place of the profile's options of the same id.
+     * in place of the profile's options of the same id, and the context window in tokens a model names as its only size.
      */
-    adopt(models: ReadonlyArray<{ slug: string; name: string }>, defaultModel: string, options: readonly ModelOptionDescriptor[] = []): boolean {
+    adopt(
+        models: ReadonlyArray<{ slug: string; name: string; contextWindow?: number }>,
+        defaultModel: string,
+        options: readonly ModelOptionDescriptor[] = []
+    ): boolean {
         if (models.length === 0 || !models.some((model) => model.slug === defaultModel)) {
             return false;
         }
         const base = this.profileOf(this.data.defaultModel) ?? { options: [], contextWindowTokens: {} };
         const replaced = new Set(options.map((option) => option.id));
-        const profile = { ...base, options: [...base.options.filter((option) => !replaced.has(option.id)), ...options] };
+        this.hostWindows ??= base.contextWindowTokens;
+        const profile = { ...base, contextWindowTokens: this.hostWindows, options: [...base.options.filter((option) => !replaced.has(option.id)), ...options] };
+        const profileName = (window: number | undefined): string => (window === undefined ? ADOPTED_PROFILE : `${ADOPTED_PROFILE}-${window}`);
+        const profiles: Record<string, ModelCatalogProfile> = {};
+        for (const model of models) {
+            profiles[profileName(model.contextWindow)] =
+                model.contextWindow === undefined ? profile : { ...profile, contextWindowTokens: { '*': model.contextWindow } };
+        }
         const data: ModelCatalogInput = {
             ...(this.data.updatedAt === undefined ? {} : { updatedAt: this.data.updatedAt }),
             defaultModel,
-            profiles: { [ADOPTED_PROFILE]: profile },
-            models: models.map((model) => ({ slug: model.slug, name: model.name, profile: ADOPTED_PROFILE }))
+            profiles,
+            models: models.map((model) => ({ slug: model.slug, name: model.name, profile: profileName(model.contextWindow) }))
         };
         const changed = JSON.stringify(data) !== JSON.stringify(this.data);
         this.data = data;

package/src/providers/index.ts

@@ -1,4 +1,5 @@
 // Public API: exports.test.ts snapshots this list, so a name added or dropped here is an API change.
+export { type AcpCatalogStore } from './acp-agent-state.ts';
 export { ACP_CAPABILITIES, type AcpProviderSpec, createAcpProvider } from './acp-provider.ts';
 export { type AcpAccountProbe, askAcpAccount, type ProbeTimer } from './accounts/acp-account.ts';
 export { AccountError, type AccountLaunches, storedAccount, launchEnv } from './accounts/launch.ts';

package/src/providers/provider.ts

@@ -50,5 +50,7 @@ export interface ChatProvider {
     enabled?(): boolean;
     /* Asks the CLI, started in an account's environment, who is signed in there. Absent leaves the host's own reader. */
     askAccount?(command: readonly string[], env: Record<string, string | undefined>): Promise<AccountReading>;
+    /* Calls the listener whenever the models or the capabilities changed, for a provider that learns them from its CLI; answers how to stop. */
+    onChange?(listener: () => void): () => void;
     createBackend(launch: BackendLaunch, host: BackendHost): ChatBackend;
 }

package/src/providers/registry.ts

@@ -128,6 +128,16 @@ export class ProviderRegistry {
         return this.get(kind).enabled?.() !== false;
     }
 
+    /* Calls the listener with the kind of every provider whose models or capabilities changed, so a host can list them again; answers how to stop. */
+    onChange(listener: (kind: AgentKind) => void): () => void {
+        const stops = this.providers.flatMap((provider) => (provider.onChange ? [provider.onChange(() => listener(provider.kind))] : []));
+        return () => {
+            for (const stop of stops) {
+                stop();
+            }
+        };
+    }
+
     invalidate(kind: AgentKind): void {
         this.cache.delete(kind);
     }

package/src/testing/fake-acp.ts

@@ -27,6 +27,12 @@ export interface FakeAcpOptions {
     // Offers a reasoning effort as the config option `reasoning_effort`, without a category: Low and High, and
     // Extra high on `fake-large`. `reject` refuses every change to it.
     reasoningEffort?: 'accept' | 'reject';
+    // Names each model's context window in its `_meta` (`totalContextTokens`): 128000 for `fake-small`, 1000000 for `fake-large`.
+    contextWindows?: boolean;
+    // The slash commands a new session lists, sent before the answer that names the session.
+    commands?: readonly string[];
+    // Advertises `promptCapabilities.embeddedContext`, so a prompt may carry files as `resource` blocks.
+    embeddedContext?: boolean;
 }
 
 export function fakeAcpWith(options: FakeAcpOptions): FakeCli {
@@ -74,9 +80,10 @@ export function fakeAcpWith(options: FakeAcpOptions): FakeCli {
         };
 
         const sessionState = (): Frame => {
+            const meta = (totalContextTokens: number): Frame => (options.contextWindows ? { _meta: { totalContextTokens } } : {});
             const modelChoices = [
-                { value: 'fake-small', name: 'Fake small' },
-                { value: 'fake-large', name: 'Fake large' }
+                { value: 'fake-small', name: 'Fake small', ...meta(128000) },
+                { value: 'fake-large', name: 'Fake large', ...meta(1000000) }
             ];
             const effortChoices = [
                 { value: 'low', name: 'Low', description: 'Answers quickly' },
@@ -90,7 +97,7 @@ export function fakeAcpWith(options: FakeAcpOptions): FakeCli {
             return {
                 ...(modes.length === 0 ? {} : { modes: { currentModeId: mode, availableModes: modes.map((id) => ({ id, name: id })) } }),
                 ...(options.legacyModels
-                    ? { models: { currentModelId: model, availableModels: modelChoices.map((choice) => ({ modelId: choice.value, name: choice.name })) } }
+                    ? { models: { currentModelId: model, availableModels: modelChoices.map(({ value, ...choice }) => ({ modelId: value, ...choice })) } }
                     : {
                           configOptions: [
                               { id: 'model', name: 'Model', type: 'select', category: 'model', currentValue: model, options: modelChoices },
@@ -233,7 +240,7 @@ export function fakeAcpWith(options: FakeAcpOptions): FakeCli {
                         protocolVersion: 1,
                         agentCapabilities: {
                             loadSession: options.loadSession ?? true,
-                            promptCapabilities: { image: true, audio: false, embeddedContext: false },
+                            promptCapabilities: { image: true, audio: false, embeddedContext: options.embeddedContext === true },
                             sessionCapabilities: { ...(options.resumeSession ? { resume: {} } : {}), ...(options.closeSession ? { close: {} } : {}) }
                         },
                         authMethods: options.authMethod === undefined ? [] : [{ id: options.authMethod, name: 'Sign in' }],
@@ -251,6 +258,12 @@ export function fakeAcpWith(options: FakeAcpOptions): FakeCli {
                     }
                     sessionId = `fake-session-${Math.random().toString(36).slice(2, 8)}`;
                     sessionHistory.set(sessionId, []);
+                    if (options.commands !== undefined) {
+                        update({
+                            sessionUpdate: 'available_commands_update',
+                            availableCommands: options.commands.map((name) => ({ name, description: name }))
+                        });
+                    }
                     respond(id, { sessionId, ...sessionState() });
                     return;
                 case 'session/load':