mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 01:50:39 +09:00
feat(adapters): add capability flags to ServerAdapterModule (#3540)
## Thinking Path > - Paperclip orchestrates AI agents via adapters (`claude_local`, `codex_local`, etc.) > - Each adapter type has different capabilities — instructions bundles, skill materialization, local JWT — but these were gated by 5 hardcoded type lists scattered across server routes and UI components > - External adapter plugins (e.g. a future `opencode_k8s`) cannot add themselves to those hardcoded lists without patching Paperclip source > - The existing `supportsLocalAgentJwt` field on `ServerAdapterModule` proves the right pattern already exists; it just wasn't applied to the other capability gates > - This pull request replaces the 4 remaining hardcoded lists with declarative capability flags on `ServerAdapterModule`, exposed through the adapter listing API > - The benefit is that external adapter plugins can now declare their own capabilities without any changes to Paperclip source code ## What Changed - **`packages/adapter-utils/src/types.ts`** — added optional capability fields to `ServerAdapterModule`: `supportsInstructionsBundle`, `instructionsPathKey`, `requiresMaterializedRuntimeSkills` - **`server/src/routes/agents.ts`** — replaced `DEFAULT_MANAGED_INSTRUCTIONS_ADAPTER_TYPES` and `ADAPTERS_REQUIRING_MATERIALIZED_RUNTIME_SKILLS` hardcoded sets with capability-aware helper functions that fall back to the legacy sets for adapters that don't set flags - **`server/src/routes/adapters.ts`** — `GET /api/adapters` now includes a `capabilities` object per adapter (all four flags + derived `supportsSkills`) - **`server/src/adapters/registry.ts`** — all built-in adapters (`claude_local`, `codex_local`, `process`, `cursor`) now declare flags explicitly - **`ui/src/adapters/use-adapter-capabilities.ts`** — new hook that fetches adapter capabilities from the API - **`ui/src/pages/AgentDetail.tsx`** — replaced hardcoded `isLocal` allowlist with `capabilities.supportsInstructionsBundle` from the API - **`ui/src/components/AgentConfigForm.tsx`** / **`OnboardingWizard.tsx`** — replaced `NONLOCAL_TYPES` denylist with capability-based checks - **`server/src/__tests__/adapter-registry.test.ts`** / **`adapter-routes.test.ts`** — tests covering flag exposure, undefined-when-unset, and per-adapter values - **`docs/adapters/creating-an-adapter.md`** — new "Capability Flags" section documenting all flags and an example for external plugin authors ## Verification - Run `pnpm test --filter=@paperclip/server -- adapter-registry adapter-routes` — all new tests pass - Run `pnpm test --filter=@paperclip/adapter-utils` — existing tests still pass - Spin up dev server, open an agent with `claude_local` type — instructions bundle tab still visible - Create/open an agent with a non-local type — instructions bundle tab still hidden - Call `GET /api/adapters` and verify each adapter includes a `capabilities` object with the correct flags ## Risks - **Low risk overall** — all new flags are optional with backwards-compatible fallbacks to the existing hardcoded sets; no adapter behaviour changes unless a flag is explicitly set - Adapters that do not declare flags continue to use the legacy lists, so there is no regression risk for built-in adapters - The UI capability hook adds one API call to AgentDetail mount; this is a pre-existing endpoint, so no new latency path is introduced ## Model Used - Provider: Anthropic - Model: Claude Sonnet 4.6 (`claude-sonnet-4-6`) - Context: 200k token context window - Mode: Agentic tool use (code editing, bash, grep, file reads) ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Pawla Abdul (Bot) <pawla@groombook.dev> Co-authored-by: Paperclip <noreply@paperclip.ing>
This commit is contained in:
parent
f6ce976544
commit
50cd76d8a3
13 changed files with 329 additions and 15 deletions
|
|
@ -203,6 +203,43 @@ export const sessionCodec: AdapterSessionCodec = {
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Capability Flags
|
||||||
|
|
||||||
|
Adapters can declare what "local" capabilities they support by setting optional fields on the `ServerAdapterModule`. The server and UI use these flags to decide which features to enable for agents using the adapter (instructions bundle editor, skills sync, JWT auth, etc.).
|
||||||
|
|
||||||
|
| Flag | Type | Default | What it controls |
|
||||||
|
|------|------|---------|------------------|
|
||||||
|
| `supportsLocalAgentJwt` | `boolean` | `false` | Whether heartbeat generates a local JWT for the agent |
|
||||||
|
| `supportsInstructionsBundle` | `boolean` | `false` | Managed instructions bundle (AGENTS.md) — server-side resolution + UI editor |
|
||||||
|
| `instructionsPathKey` | `string` | `"instructionsFilePath"` | The `adapterConfig` key that holds the instructions file path |
|
||||||
|
| `requiresMaterializedRuntimeSkills` | `boolean` | `false` | Whether runtime skill entries must be written to disk before execution |
|
||||||
|
|
||||||
|
These flags are exposed via `GET /api/adapters` in a `capabilities` object, along with a derived `supportsSkills` flag (true when `listSkills` or `syncSkills` is defined).
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export function createServerAdapter(): ServerAdapterModule {
|
||||||
|
return {
|
||||||
|
type: "my_k8s_adapter",
|
||||||
|
execute: myExecute,
|
||||||
|
testEnvironment: myTestEnvironment,
|
||||||
|
listSkills: myListSkills,
|
||||||
|
syncSkills: mySyncSkills,
|
||||||
|
|
||||||
|
// Capability flags
|
||||||
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: true,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
With these flags set, the Paperclip UI will automatically show the instructions bundle editor, skills management tab, and working directory field for agents using this adapter — no Paperclip source changes required.
|
||||||
|
|
||||||
|
If capability flags are not set, the server falls back to legacy hardcoded lists for built-in adapter types. External adapters that omit the flags will default to `false` for all capabilities.
|
||||||
|
|
||||||
## Skills Injection
|
## Skills Injection
|
||||||
|
|
||||||
Make Paperclip skills discoverable to your agent runtime without writing to the agent's working directory:
|
Make Paperclip skills discoverable to your agent runtime without writing to the agent's working directory:
|
||||||
|
|
|
||||||
|
|
@ -328,6 +328,36 @@ export interface ServerAdapterModule {
|
||||||
* resolved inside this method — the caller receives a fully hydrated schema.
|
* resolved inside this method — the caller receives a fully hydrated schema.
|
||||||
*/
|
*/
|
||||||
getConfigSchema?: () => Promise<AdapterConfigSchema> | AdapterConfigSchema;
|
getConfigSchema?: () => Promise<AdapterConfigSchema> | AdapterConfigSchema;
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Adapter capability flags
|
||||||
|
//
|
||||||
|
// These allow adapter plugins to declare what "local" capabilities they
|
||||||
|
// support, replacing hardcoded type lists in the server and UI.
|
||||||
|
// All flags are optional — when undefined, the server falls back to
|
||||||
|
// legacy hardcoded lists for built-in adapters.
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adapter supports managed instructions bundle (AGENTS.md files).
|
||||||
|
* When true, the server uses instructionsPathKey (default "instructionsFilePath")
|
||||||
|
* to resolve the instructions config key, and the UI shows the bundle editor.
|
||||||
|
* Built-in local adapters default to true; external plugins must opt in.
|
||||||
|
*/
|
||||||
|
supportsInstructionsBundle?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The adapterConfig key that holds the instructions file path.
|
||||||
|
* Defaults to "instructionsFilePath" when supportsInstructionsBundle is true.
|
||||||
|
*/
|
||||||
|
instructionsPathKey?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adapter needs runtime skill entries materialized (written to disk)
|
||||||
|
* before being passed via config. Used by adapters that scan a directory
|
||||||
|
* rather than reading config.paperclipRuntimeSkills.
|
||||||
|
*/
|
||||||
|
requiresMaterializedRuntimeSkills?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
|
@ -95,6 +95,51 @@ describe("server adapter registry", () => {
|
||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("exposes capability flags from registered adapters", () => {
|
||||||
|
const adapterWithCaps: ServerAdapterModule = {
|
||||||
|
type: "external_test",
|
||||||
|
execute: async () => ({ exitCode: 0, signal: null, timedOut: false }),
|
||||||
|
testEnvironment: async () => ({
|
||||||
|
adapterType: "external_test",
|
||||||
|
status: "pass" as const,
|
||||||
|
checks: [],
|
||||||
|
testedAt: new Date(0).toISOString(),
|
||||||
|
}),
|
||||||
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "customPathKey",
|
||||||
|
requiresMaterializedRuntimeSkills: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
registerServerAdapter(adapterWithCaps);
|
||||||
|
|
||||||
|
const resolved = findActiveServerAdapter("external_test");
|
||||||
|
expect(resolved).not.toBeNull();
|
||||||
|
expect(resolved!.supportsInstructionsBundle).toBe(true);
|
||||||
|
expect(resolved!.instructionsPathKey).toBe("customPathKey");
|
||||||
|
expect(resolved!.requiresMaterializedRuntimeSkills).toBe(true);
|
||||||
|
expect(resolved!.supportsLocalAgentJwt).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns undefined for capability flags on adapters that do not set them", () => {
|
||||||
|
registerServerAdapter(externalAdapter);
|
||||||
|
|
||||||
|
const resolved = findActiveServerAdapter("external_test");
|
||||||
|
expect(resolved).not.toBeNull();
|
||||||
|
expect(resolved!.supportsInstructionsBundle).toBeUndefined();
|
||||||
|
expect(resolved!.instructionsPathKey).toBeUndefined();
|
||||||
|
expect(resolved!.requiresMaterializedRuntimeSkills).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("built-in claude_local adapter declares capability flags", () => {
|
||||||
|
const adapter = findActiveServerAdapter("claude_local");
|
||||||
|
expect(adapter).not.toBeNull();
|
||||||
|
expect(adapter!.supportsInstructionsBundle).toBe(true);
|
||||||
|
expect(adapter!.instructionsPathKey).toBe("instructionsFilePath");
|
||||||
|
expect(adapter!.requiresMaterializedRuntimeSkills).toBe(false);
|
||||||
|
expect(adapter!.supportsLocalAgentJwt).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
it("switches active adapter behavior back to the builtin when an override is paused", async () => {
|
it("switches active adapter behavior back to the builtin when an override is paused", async () => {
|
||||||
const builtIn = findServerAdapter("claude_local");
|
const builtIn = findServerAdapter("claude_local");
|
||||||
expect(builtIn).not.toBeNull();
|
expect(builtIn).not.toBeNull();
|
||||||
|
|
|
||||||
|
|
@ -77,6 +77,75 @@ describe("adapter routes", () => {
|
||||||
unregisterServerAdapter("claude_local");
|
unregisterServerAdapter("claude_local");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("GET /api/adapters includes capabilities object for each adapter", async () => {
|
||||||
|
const app = createApp();
|
||||||
|
|
||||||
|
const res = await request(app).get("/api/adapters");
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(Array.isArray(res.body)).toBe(true);
|
||||||
|
expect(res.body.length).toBeGreaterThan(0);
|
||||||
|
|
||||||
|
// Every adapter should have a capabilities object
|
||||||
|
for (const adapter of res.body) {
|
||||||
|
expect(adapter.capabilities).toBeDefined();
|
||||||
|
expect(typeof adapter.capabilities.supportsInstructionsBundle).toBe("boolean");
|
||||||
|
expect(typeof adapter.capabilities.supportsSkills).toBe("boolean");
|
||||||
|
expect(typeof adapter.capabilities.supportsLocalAgentJwt).toBe("boolean");
|
||||||
|
expect(typeof adapter.capabilities.requiresMaterializedRuntimeSkills).toBe("boolean");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("GET /api/adapters returns correct capabilities for built-in adapters", async () => {
|
||||||
|
const app = createApp();
|
||||||
|
|
||||||
|
const res = await request(app).get("/api/adapters");
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
|
||||||
|
// codex_local has instructions bundle + skills + jwt, no materialized skills
|
||||||
|
// (claude_local is overridden by beforeEach, so check codex_local instead)
|
||||||
|
const codexLocal = res.body.find((a: any) => a.type === "codex_local");
|
||||||
|
expect(codexLocal).toBeDefined();
|
||||||
|
expect(codexLocal.capabilities).toMatchObject({
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
supportsSkills: true,
|
||||||
|
supportsLocalAgentJwt: true,
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
|
});
|
||||||
|
|
||||||
|
// process adapter should have no local capabilities
|
||||||
|
const processAdapter = res.body.find((a: any) => a.type === "process");
|
||||||
|
expect(processAdapter).toBeDefined();
|
||||||
|
expect(processAdapter.capabilities).toMatchObject({
|
||||||
|
supportsInstructionsBundle: false,
|
||||||
|
supportsSkills: false,
|
||||||
|
supportsLocalAgentJwt: false,
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
|
});
|
||||||
|
|
||||||
|
// cursor adapter should require materialized runtime skills
|
||||||
|
const cursorAdapter = res.body.find((a: any) => a.type === "cursor");
|
||||||
|
expect(cursorAdapter).toBeDefined();
|
||||||
|
expect(cursorAdapter.capabilities.requiresMaterializedRuntimeSkills).toBe(true);
|
||||||
|
expect(cursorAdapter.capabilities.supportsInstructionsBundle).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("GET /api/adapters derives supportsSkills from listSkills/syncSkills presence", async () => {
|
||||||
|
const app = createApp();
|
||||||
|
|
||||||
|
const res = await request(app).get("/api/adapters");
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
|
||||||
|
// http adapter has no listSkills/syncSkills
|
||||||
|
const httpAdapter = res.body.find((a: any) => a.type === "http");
|
||||||
|
expect(httpAdapter).toBeDefined();
|
||||||
|
expect(httpAdapter.capabilities.supportsSkills).toBe(false);
|
||||||
|
|
||||||
|
// codex_local has listSkills/syncSkills
|
||||||
|
const codexLocal = res.body.find((a: any) => a.type === "codex_local");
|
||||||
|
expect(codexLocal).toBeDefined();
|
||||||
|
expect(codexLocal.capabilities.supportsSkills).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
it("uses the active adapter when resolving config schema for a paused builtin override", async () => {
|
it("uses the active adapter when resolving config schema for a paused builtin override", async () => {
|
||||||
const app = createApp();
|
const app = createApp();
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -97,6 +97,9 @@ const claudeLocalAdapter: ServerAdapterModule = {
|
||||||
models: claudeModels,
|
models: claudeModels,
|
||||||
listModels: listClaudeModels,
|
listModels: listClaudeModels,
|
||||||
supportsLocalAgentJwt: true,
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
agentConfigurationDoc: claudeAgentConfigurationDoc,
|
agentConfigurationDoc: claudeAgentConfigurationDoc,
|
||||||
getQuotaWindows: claudeGetQuotaWindows,
|
getQuotaWindows: claudeGetQuotaWindows,
|
||||||
};
|
};
|
||||||
|
|
@ -112,6 +115,9 @@ const codexLocalAdapter: ServerAdapterModule = {
|
||||||
models: codexModels,
|
models: codexModels,
|
||||||
listModels: listCodexModels,
|
listModels: listCodexModels,
|
||||||
supportsLocalAgentJwt: true,
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
agentConfigurationDoc: codexAgentConfigurationDoc,
|
agentConfigurationDoc: codexAgentConfigurationDoc,
|
||||||
getQuotaWindows: codexGetQuotaWindows,
|
getQuotaWindows: codexGetQuotaWindows,
|
||||||
};
|
};
|
||||||
|
|
@ -127,6 +133,9 @@ const cursorLocalAdapter: ServerAdapterModule = {
|
||||||
models: cursorModels,
|
models: cursorModels,
|
||||||
listModels: listCursorModels,
|
listModels: listCursorModels,
|
||||||
supportsLocalAgentJwt: true,
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: true,
|
||||||
agentConfigurationDoc: cursorAgentConfigurationDoc,
|
agentConfigurationDoc: cursorAgentConfigurationDoc,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
@ -140,6 +149,9 @@ const geminiLocalAdapter: ServerAdapterModule = {
|
||||||
sessionManagement: getAdapterSessionManagement("gemini_local") ?? undefined,
|
sessionManagement: getAdapterSessionManagement("gemini_local") ?? undefined,
|
||||||
models: geminiModels,
|
models: geminiModels,
|
||||||
supportsLocalAgentJwt: true,
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: true,
|
||||||
agentConfigurationDoc: geminiAgentConfigurationDoc,
|
agentConfigurationDoc: geminiAgentConfigurationDoc,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
@ -149,6 +161,8 @@ const openclawGatewayAdapter: ServerAdapterModule = {
|
||||||
testEnvironment: openclawGatewayTestEnvironment,
|
testEnvironment: openclawGatewayTestEnvironment,
|
||||||
models: openclawGatewayModels,
|
models: openclawGatewayModels,
|
||||||
supportsLocalAgentJwt: false,
|
supportsLocalAgentJwt: false,
|
||||||
|
supportsInstructionsBundle: false,
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
agentConfigurationDoc: openclawGatewayAgentConfigurationDoc,
|
agentConfigurationDoc: openclawGatewayAgentConfigurationDoc,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
@ -163,6 +177,9 @@ const openCodeLocalAdapter: ServerAdapterModule = {
|
||||||
sessionManagement: getAdapterSessionManagement("opencode_local") ?? undefined,
|
sessionManagement: getAdapterSessionManagement("opencode_local") ?? undefined,
|
||||||
listModels: listOpenCodeModels,
|
listModels: listOpenCodeModels,
|
||||||
supportsLocalAgentJwt: true,
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: true,
|
||||||
agentConfigurationDoc: openCodeAgentConfigurationDoc,
|
agentConfigurationDoc: openCodeAgentConfigurationDoc,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
@ -177,6 +194,9 @@ const piLocalAdapter: ServerAdapterModule = {
|
||||||
models: [],
|
models: [],
|
||||||
listModels: listPiModels,
|
listModels: listPiModels,
|
||||||
supportsLocalAgentJwt: true,
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: true,
|
||||||
agentConfigurationDoc: piAgentConfigurationDoc,
|
agentConfigurationDoc: piAgentConfigurationDoc,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
@ -189,6 +209,9 @@ const hermesLocalAdapter: ServerAdapterModule = {
|
||||||
syncSkills: hermesSyncSkills,
|
syncSkills: hermesSyncSkills,
|
||||||
models: hermesModels,
|
models: hermesModels,
|
||||||
supportsLocalAgentJwt: true,
|
supportsLocalAgentJwt: true,
|
||||||
|
supportsInstructionsBundle: true,
|
||||||
|
instructionsPathKey: "instructionsFilePath",
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
agentConfigurationDoc: hermesAgentConfigurationDoc,
|
agentConfigurationDoc: hermesAgentConfigurationDoc,
|
||||||
detectModel: () => detectModelFromHermes(),
|
detectModel: () => detectModelFromHermes(),
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -59,6 +59,13 @@ interface AdapterInstallRequest {
|
||||||
version?: string;
|
version?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface AdapterCapabilities {
|
||||||
|
supportsInstructionsBundle: boolean;
|
||||||
|
supportsSkills: boolean;
|
||||||
|
supportsLocalAgentJwt: boolean;
|
||||||
|
requiresMaterializedRuntimeSkills: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
interface AdapterInfo {
|
interface AdapterInfo {
|
||||||
type: string;
|
type: string;
|
||||||
label: string;
|
label: string;
|
||||||
|
|
@ -66,6 +73,7 @@ interface AdapterInfo {
|
||||||
modelsCount: number;
|
modelsCount: number;
|
||||||
loaded: boolean;
|
loaded: boolean;
|
||||||
disabled: boolean;
|
disabled: boolean;
|
||||||
|
capabilities: AdapterCapabilities;
|
||||||
/** True when an external plugin has replaced a built-in adapter of the same type. */
|
/** True when an external plugin has replaced a built-in adapter of the same type. */
|
||||||
overriddenBuiltin?: boolean;
|
overriddenBuiltin?: boolean;
|
||||||
/** True when the external override for a builtin type is currently paused. */
|
/** True when the external override for a builtin type is currently paused. */
|
||||||
|
|
@ -103,6 +111,15 @@ function readAdapterPackageVersionFromDisk(record: AdapterPluginRecord): string
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function buildAdapterCapabilities(adapter: ServerAdapterModule): AdapterCapabilities {
|
||||||
|
return {
|
||||||
|
supportsInstructionsBundle: adapter.supportsInstructionsBundle ?? false,
|
||||||
|
supportsSkills: Boolean(adapter.listSkills || adapter.syncSkills),
|
||||||
|
supportsLocalAgentJwt: adapter.supportsLocalAgentJwt ?? false,
|
||||||
|
requiresMaterializedRuntimeSkills: adapter.requiresMaterializedRuntimeSkills ?? false,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
function buildAdapterInfo(adapter: ServerAdapterModule, externalRecord: AdapterPluginRecord | undefined, disabledSet: Set<string>): AdapterInfo {
|
function buildAdapterInfo(adapter: ServerAdapterModule, externalRecord: AdapterPluginRecord | undefined, disabledSet: Set<string>): AdapterInfo {
|
||||||
const fromDisk = externalRecord ? readAdapterPackageVersionFromDisk(externalRecord) : undefined;
|
const fromDisk = externalRecord ? readAdapterPackageVersionFromDisk(externalRecord) : undefined;
|
||||||
return {
|
return {
|
||||||
|
|
@ -112,6 +129,7 @@ function buildAdapterInfo(adapter: ServerAdapterModule, externalRecord: AdapterP
|
||||||
modelsCount: (adapter.models ?? []).length,
|
modelsCount: (adapter.models ?? []).length,
|
||||||
loaded: true, // If it's in the registry, it's loaded
|
loaded: true, // If it's in the registry, it's loaded
|
||||||
disabled: disabledSet.has(adapter.type),
|
disabled: disabledSet.has(adapter.type),
|
||||||
|
capabilities: buildAdapterCapabilities(adapter),
|
||||||
overriddenBuiltin: externalRecord ? BUILTIN_ADAPTER_TYPES.has(adapter.type) : undefined,
|
overriddenBuiltin: externalRecord ? BUILTIN_ADAPTER_TYPES.has(adapter.type) : undefined,
|
||||||
overridePaused: BUILTIN_ADAPTER_TYPES.has(adapter.type) ? isOverridePaused(adapter.type) : undefined,
|
overridePaused: BUILTIN_ADAPTER_TYPES.has(adapter.type) ? isOverridePaused(adapter.type) : undefined,
|
||||||
// Prefer on-disk package.json so the UI reflects bumps without relying on store-only fields.
|
// Prefer on-disk package.json so the UI reflects bumps without relying on store-only fields.
|
||||||
|
|
|
||||||
|
|
@ -72,6 +72,8 @@ import {
|
||||||
import { getTelemetryClient } from "../telemetry.js";
|
import { getTelemetryClient } from "../telemetry.js";
|
||||||
|
|
||||||
export function agentRoutes(db: Db) {
|
export function agentRoutes(db: Db) {
|
||||||
|
// Legacy hardcoded maps — used as fallback when adapter module does not
|
||||||
|
// declare capability flags explicitly.
|
||||||
const DEFAULT_INSTRUCTIONS_PATH_KEYS: Record<string, string> = {
|
const DEFAULT_INSTRUCTIONS_PATH_KEYS: Record<string, string> = {
|
||||||
claude_local: "instructionsFilePath",
|
claude_local: "instructionsFilePath",
|
||||||
codex_local: "instructionsFilePath",
|
codex_local: "instructionsFilePath",
|
||||||
|
|
@ -83,6 +85,22 @@ export function agentRoutes(db: Db) {
|
||||||
pi_local: "instructionsFilePath",
|
pi_local: "instructionsFilePath",
|
||||||
};
|
};
|
||||||
const DEFAULT_MANAGED_INSTRUCTIONS_ADAPTER_TYPES = new Set(Object.keys(DEFAULT_INSTRUCTIONS_PATH_KEYS));
|
const DEFAULT_MANAGED_INSTRUCTIONS_ADAPTER_TYPES = new Set(Object.keys(DEFAULT_INSTRUCTIONS_PATH_KEYS));
|
||||||
|
|
||||||
|
/** Check if an adapter supports the managed instructions bundle. */
|
||||||
|
function adapterSupportsInstructionsBundle(adapterType: string): boolean {
|
||||||
|
const adapter = findActiveServerAdapter(adapterType);
|
||||||
|
if (adapter?.supportsInstructionsBundle !== undefined) return adapter.supportsInstructionsBundle;
|
||||||
|
return DEFAULT_MANAGED_INSTRUCTIONS_ADAPTER_TYPES.has(adapterType);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Resolve the adapter config key for the instructions file path. */
|
||||||
|
function resolveInstructionsPathKey(adapterType: string): string | null {
|
||||||
|
const adapter = findActiveServerAdapter(adapterType);
|
||||||
|
if (adapter?.instructionsPathKey) return adapter.instructionsPathKey;
|
||||||
|
if (adapter?.supportsInstructionsBundle === true) return "instructionsFilePath";
|
||||||
|
if (adapter?.supportsInstructionsBundle === false) return null;
|
||||||
|
return DEFAULT_INSTRUCTIONS_PATH_KEYS[adapterType] ?? null;
|
||||||
|
}
|
||||||
const KNOWN_INSTRUCTIONS_PATH_KEYS = new Set(["instructionsFilePath", "agentsMdPath"]);
|
const KNOWN_INSTRUCTIONS_PATH_KEYS = new Set(["instructionsFilePath", "agentsMdPath"]);
|
||||||
const KNOWN_INSTRUCTIONS_BUNDLE_KEYS = [
|
const KNOWN_INSTRUCTIONS_BUNDLE_KEYS = [
|
||||||
"instructionsBundleMode",
|
"instructionsBundleMode",
|
||||||
|
|
@ -557,7 +575,7 @@ export function agentRoutes(db: Db) {
|
||||||
adapterType: string;
|
adapterType: string;
|
||||||
adapterConfig: unknown;
|
adapterConfig: unknown;
|
||||||
}>(agent: T): Promise<T> {
|
}>(agent: T): Promise<T> {
|
||||||
if (!DEFAULT_MANAGED_INSTRUCTIONS_ADAPTER_TYPES.has(agent.adapterType)) {
|
if (!adapterSupportsInstructionsBundle(agent.adapterType)) {
|
||||||
return agent;
|
return agent;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -638,7 +656,9 @@ export function agentRoutes(db: Db) {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
const ADAPTERS_REQUIRING_MATERIALIZED_RUNTIME_SKILLS = new Set([
|
// Legacy hardcoded set — used as fallback when adapter module does not
|
||||||
|
// declare requiresMaterializedRuntimeSkills explicitly.
|
||||||
|
const LEGACY_MATERIALIZED_SKILLS_SET = new Set([
|
||||||
"cursor",
|
"cursor",
|
||||||
"gemini_local",
|
"gemini_local",
|
||||||
"opencode_local",
|
"opencode_local",
|
||||||
|
|
@ -646,7 +666,11 @@ export function agentRoutes(db: Db) {
|
||||||
]);
|
]);
|
||||||
|
|
||||||
function shouldMaterializeRuntimeSkillsForAdapter(adapterType: string) {
|
function shouldMaterializeRuntimeSkillsForAdapter(adapterType: string) {
|
||||||
return ADAPTERS_REQUIRING_MATERIALIZED_RUNTIME_SKILLS.has(adapterType);
|
const adapter = findActiveServerAdapter(adapterType);
|
||||||
|
if (adapter?.requiresMaterializedRuntimeSkills !== undefined) {
|
||||||
|
return adapter.requiresMaterializedRuntimeSkills;
|
||||||
|
}
|
||||||
|
return LEGACY_MATERIALIZED_SKILLS_SET.has(adapterType);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function buildRuntimeSkillConfig(
|
async function buildRuntimeSkillConfig(
|
||||||
|
|
@ -1617,7 +1641,7 @@ export function agentRoutes(db: Db) {
|
||||||
|
|
||||||
const existingAdapterConfig = asRecord(existing.adapterConfig) ?? {};
|
const existingAdapterConfig = asRecord(existing.adapterConfig) ?? {};
|
||||||
const explicitKey = asNonEmptyString(req.body.adapterConfigKey);
|
const explicitKey = asNonEmptyString(req.body.adapterConfigKey);
|
||||||
const defaultKey = DEFAULT_INSTRUCTIONS_PATH_KEYS[existing.adapterType] ?? null;
|
const defaultKey = resolveInstructionsPathKey(existing.adapterType);
|
||||||
const adapterConfigKey = explicitKey ?? defaultKey;
|
const adapterConfigKey = explicitKey ?? defaultKey;
|
||||||
if (!adapterConfigKey) {
|
if (!adapterConfigKey) {
|
||||||
res.status(422).json({
|
res.status(422).json({
|
||||||
|
|
|
||||||
54
ui/src/adapters/use-adapter-capabilities.ts
Normal file
54
ui/src/adapters/use-adapter-capabilities.ts
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
import { useMemo } from "react";
|
||||||
|
import { useQuery } from "@tanstack/react-query";
|
||||||
|
import { adaptersApi, type AdapterCapabilities } from "@/api/adapters";
|
||||||
|
import { queryKeys } from "@/lib/queryKeys";
|
||||||
|
|
||||||
|
const ALL_FALSE: AdapterCapabilities = {
|
||||||
|
supportsInstructionsBundle: false,
|
||||||
|
supportsSkills: false,
|
||||||
|
supportsLocalAgentJwt: false,
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Synchronous fallback for known built-in adapter types so capability checks
|
||||||
|
* return correct values on first render before the /api/adapters call resolves.
|
||||||
|
*/
|
||||||
|
const KNOWN_DEFAULTS: Record<string, AdapterCapabilities> = {
|
||||||
|
claude_local: { supportsInstructionsBundle: true, supportsSkills: true, supportsLocalAgentJwt: true, requiresMaterializedRuntimeSkills: false },
|
||||||
|
codex_local: { supportsInstructionsBundle: true, supportsSkills: true, supportsLocalAgentJwt: true, requiresMaterializedRuntimeSkills: false },
|
||||||
|
cursor: { supportsInstructionsBundle: true, supportsSkills: true, supportsLocalAgentJwt: true, requiresMaterializedRuntimeSkills: true },
|
||||||
|
gemini_local: { supportsInstructionsBundle: true, supportsSkills: true, supportsLocalAgentJwt: true, requiresMaterializedRuntimeSkills: true },
|
||||||
|
opencode_local: { supportsInstructionsBundle: true, supportsSkills: true, supportsLocalAgentJwt: true, requiresMaterializedRuntimeSkills: true },
|
||||||
|
pi_local: { supportsInstructionsBundle: true, supportsSkills: true, supportsLocalAgentJwt: true, requiresMaterializedRuntimeSkills: true },
|
||||||
|
hermes_local: { supportsInstructionsBundle: true, supportsSkills: true, supportsLocalAgentJwt: true, requiresMaterializedRuntimeSkills: false },
|
||||||
|
openclaw_gateway: ALL_FALSE,
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a lookup function that resolves adapter capabilities by type.
|
||||||
|
*
|
||||||
|
* Capabilities are fetched from the server adapter listing API and cached
|
||||||
|
* via react-query. Before the data loads, known built-in adapter types
|
||||||
|
* return correct synchronous defaults to avoid cold-load regressions.
|
||||||
|
*/
|
||||||
|
export function useAdapterCapabilities(): (type: string) => AdapterCapabilities {
|
||||||
|
const { data: adapters } = useQuery({
|
||||||
|
queryKey: queryKeys.adapters.all,
|
||||||
|
queryFn: () => adaptersApi.list(),
|
||||||
|
staleTime: 5 * 60 * 1000,
|
||||||
|
});
|
||||||
|
|
||||||
|
const capMap = useMemo(() => {
|
||||||
|
const map = new Map<string, AdapterCapabilities>();
|
||||||
|
if (adapters) {
|
||||||
|
for (const a of adapters) {
|
||||||
|
map.set(a.type, a.capabilities);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return map;
|
||||||
|
}, [adapters]);
|
||||||
|
|
||||||
|
return (type: string): AdapterCapabilities =>
|
||||||
|
capMap.get(type) ?? KNOWN_DEFAULTS[type] ?? ALL_FALSE;
|
||||||
|
}
|
||||||
|
|
@ -4,6 +4,13 @@
|
||||||
|
|
||||||
import { api } from "./client";
|
import { api } from "./client";
|
||||||
|
|
||||||
|
export interface AdapterCapabilities {
|
||||||
|
supportsInstructionsBundle: boolean;
|
||||||
|
supportsSkills: boolean;
|
||||||
|
supportsLocalAgentJwt: boolean;
|
||||||
|
requiresMaterializedRuntimeSkills: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
export interface AdapterInfo {
|
export interface AdapterInfo {
|
||||||
type: string;
|
type: string;
|
||||||
label: string;
|
label: string;
|
||||||
|
|
@ -11,6 +18,7 @@ export interface AdapterInfo {
|
||||||
modelsCount: number;
|
modelsCount: number;
|
||||||
loaded: boolean;
|
loaded: boolean;
|
||||||
disabled: boolean;
|
disabled: boolean;
|
||||||
|
capabilities: AdapterCapabilities;
|
||||||
/** Installed version (for external npm adapters) */
|
/** Installed version (for external npm adapters) */
|
||||||
version?: string;
|
version?: string;
|
||||||
/** Package name (for external adapters) */
|
/** Package name (for external adapters) */
|
||||||
|
|
|
||||||
|
|
@ -50,6 +50,7 @@ import { listAdapterOptions, listVisibleAdapterTypes } from "../adapters/metadat
|
||||||
import { getAdapterLabel } from "../adapters/adapter-display-registry";
|
import { getAdapterLabel } from "../adapters/adapter-display-registry";
|
||||||
import { useDisabledAdaptersSync } from "../adapters/use-disabled-adapters";
|
import { useDisabledAdaptersSync } from "../adapters/use-disabled-adapters";
|
||||||
import { buildAgentUpdatePatch, type AgentConfigOverlay } from "../lib/agent-config-patch";
|
import { buildAgentUpdatePatch, type AgentConfigOverlay } from "../lib/agent-config-patch";
|
||||||
|
import { useAdapterCapabilities } from "../adapters/use-adapter-capabilities";
|
||||||
|
|
||||||
/* ---- Create mode values ---- */
|
/* ---- Create mode values ---- */
|
||||||
|
|
||||||
|
|
@ -269,8 +270,9 @@ export function AgentConfigForm(props: AgentConfigFormProps) {
|
||||||
const adapterType = isCreate
|
const adapterType = isCreate
|
||||||
? props.values.adapterType
|
? props.values.adapterType
|
||||||
: overlay.adapterType ?? props.agent.adapterType;
|
: overlay.adapterType ?? props.agent.adapterType;
|
||||||
const NONLOCAL_TYPES = new Set(["process", "http", "openclaw_gateway"]);
|
const getCapabilities = useAdapterCapabilities();
|
||||||
const isLocal = !NONLOCAL_TYPES.has(adapterType);
|
const adapterCaps = getCapabilities(adapterType);
|
||||||
|
const isLocal = adapterCaps.supportsInstructionsBundle || adapterCaps.supportsSkills || adapterCaps.supportsLocalAgentJwt;
|
||||||
|
|
||||||
const showLegacyWorkingDirectoryField =
|
const showLegacyWorkingDirectoryField =
|
||||||
isLocal && shouldShowLegacyWorkingDirectoryField({ isCreate, adapterConfig: config });
|
isLocal && shouldShowLegacyWorkingDirectoryField({ isCreate, adapterConfig: config });
|
||||||
|
|
|
||||||
|
|
@ -25,6 +25,7 @@ import {
|
||||||
import { getUIAdapter } from "../adapters";
|
import { getUIAdapter } from "../adapters";
|
||||||
import { listUIAdapters } from "../adapters";
|
import { listUIAdapters } from "../adapters";
|
||||||
import { useDisabledAdaptersSync } from "../adapters/use-disabled-adapters";
|
import { useDisabledAdaptersSync } from "../adapters/use-disabled-adapters";
|
||||||
|
import { useAdapterCapabilities } from "../adapters/use-adapter-capabilities";
|
||||||
import { getAdapterDisplay } from "../adapters/adapter-display-registry";
|
import { getAdapterDisplay } from "../adapters/adapter-display-registry";
|
||||||
import { defaultCreateValues } from "./agent-config-defaults";
|
import { defaultCreateValues } from "./agent-config-defaults";
|
||||||
import { parseOnboardingGoalInput } from "../lib/onboarding-goal";
|
import { parseOnboardingGoalInput } from "../lib/onboarding-goal";
|
||||||
|
|
@ -198,8 +199,9 @@ export function OnboardingWizard() {
|
||||||
queryFn: () => agentsApi.adapterModels(createdCompanyId!, adapterType),
|
queryFn: () => agentsApi.adapterModels(createdCompanyId!, adapterType),
|
||||||
enabled: Boolean(createdCompanyId) && effectiveOnboardingOpen && step === 2
|
enabled: Boolean(createdCompanyId) && effectiveOnboardingOpen && step === 2
|
||||||
});
|
});
|
||||||
const NONLOCAL_TYPES = new Set(["process", "http", "openclaw_gateway"]);
|
const getCapabilities = useAdapterCapabilities();
|
||||||
const isLocalAdapter = !NONLOCAL_TYPES.has(adapterType);
|
const adapterCaps = getCapabilities(adapterType);
|
||||||
|
const isLocalAdapter = adapterCaps.supportsInstructionsBundle || adapterCaps.supportsSkills || adapterCaps.supportsLocalAgentJwt;
|
||||||
|
|
||||||
// Build adapter grids dynamically from the UI registry + display metadata.
|
// Build adapter grids dynamically from the UI registry + display metadata.
|
||||||
// External/plugin adapters automatically appear with generic defaults.
|
// External/plugin adapters automatically appear with generic defaults.
|
||||||
|
|
|
||||||
|
|
@ -610,6 +610,12 @@ export function AdapterManager() {
|
||||||
modelsCount: 0,
|
modelsCount: 0,
|
||||||
loaded: true,
|
loaded: true,
|
||||||
disabled: virtual.menuDisabled,
|
disabled: virtual.menuDisabled,
|
||||||
|
capabilities: {
|
||||||
|
supportsInstructionsBundle: false,
|
||||||
|
supportsSkills: false,
|
||||||
|
supportsLocalAgentJwt: false,
|
||||||
|
requiresMaterializedRuntimeSkills: false,
|
||||||
|
},
|
||||||
}}
|
}}
|
||||||
canRemove={false}
|
canRemove={false}
|
||||||
onToggle={(type, disabled) => toggleMutation.mutate({ type, disabled })}
|
onToggle={(type, disabled) => toggleMutation.mutate({ type, disabled })}
|
||||||
|
|
|
||||||
|
|
@ -26,6 +26,7 @@ import { AgentConfigForm } from "../components/AgentConfigForm";
|
||||||
import { PageTabBar } from "../components/PageTabBar";
|
import { PageTabBar } from "../components/PageTabBar";
|
||||||
import { adapterLabels, roleLabels, help } from "../components/agent-config-primitives";
|
import { adapterLabels, roleLabels, help } from "../components/agent-config-primitives";
|
||||||
import { ToggleSwitch } from "@/components/ui/toggle-switch";
|
import { ToggleSwitch } from "@/components/ui/toggle-switch";
|
||||||
|
import { useAdapterCapabilities } from "@/adapters/use-adapter-capabilities";
|
||||||
import { MarkdownEditor } from "../components/MarkdownEditor";
|
import { MarkdownEditor } from "../components/MarkdownEditor";
|
||||||
import { assetsApi } from "../api/assets";
|
import { assetsApi } from "../api/assets";
|
||||||
import { getUIAdapter, buildTranscript, onAdapterChange } from "../adapters";
|
import { getUIAdapter, buildTranscript, onAdapterChange } from "../adapters";
|
||||||
|
|
@ -1719,13 +1720,8 @@ function PromptsTab({
|
||||||
externalBundleRef.current = null;
|
externalBundleRef.current = null;
|
||||||
}, [agent.id]);
|
}, [agent.id]);
|
||||||
|
|
||||||
const isLocal =
|
const getCapabilities = useAdapterCapabilities();
|
||||||
agent.adapterType === "claude_local" ||
|
const isLocal = getCapabilities(agent.adapterType).supportsInstructionsBundle;
|
||||||
agent.adapterType === "codex_local" ||
|
|
||||||
agent.adapterType === "opencode_local" ||
|
|
||||||
agent.adapterType === "pi_local" ||
|
|
||||||
agent.adapterType === "hermes_local" ||
|
|
||||||
agent.adapterType === "cursor";
|
|
||||||
|
|
||||||
const { data: bundle, isLoading: bundleLoading } = useQuery({
|
const { data: bundle, isLoading: bundleLoading } = useQuery({
|
||||||
queryKey: queryKeys.agents.instructionsBundle(agent.id),
|
queryKey: queryKeys.agents.instructionsBundle(agent.id),
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue