2026-04-04 14:04:33 -05:00
|
|
|
import { describe, expect, it, beforeEach, afterEach, vi } from "vitest";
|
2026-03-31 20:21:13 +01:00
|
|
|
import type { ServerAdapterModule } from "../adapters/index.js";
|
|
|
|
|
import {
|
2026-04-04 14:04:33 -05:00
|
|
|
detectAdapterModel,
|
|
|
|
|
findActiveServerAdapter,
|
2026-03-31 20:21:13 +01:00
|
|
|
findServerAdapter,
|
|
|
|
|
listAdapterModels,
|
|
|
|
|
registerServerAdapter,
|
|
|
|
|
requireServerAdapter,
|
|
|
|
|
unregisterServerAdapter,
|
|
|
|
|
} from "../adapters/index.js";
|
2026-04-04 14:04:33 -05:00
|
|
|
import { setOverridePaused } from "../adapters/registry.js";
|
2026-03-31 20:21:13 +01:00
|
|
|
|
|
|
|
|
const externalAdapter: ServerAdapterModule = {
|
|
|
|
|
type: "external_test",
|
|
|
|
|
execute: async () => ({
|
|
|
|
|
exitCode: 0,
|
|
|
|
|
signal: null,
|
|
|
|
|
timedOut: false,
|
|
|
|
|
}),
|
|
|
|
|
testEnvironment: async () => ({
|
|
|
|
|
adapterType: "external_test",
|
|
|
|
|
status: "pass",
|
|
|
|
|
checks: [],
|
|
|
|
|
testedAt: new Date(0).toISOString(),
|
|
|
|
|
}),
|
|
|
|
|
models: [{ id: "external-model", label: "External Model" }],
|
|
|
|
|
supportsLocalAgentJwt: false,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
describe("server adapter registry", () => {
|
|
|
|
|
beforeEach(() => {
|
|
|
|
|
unregisterServerAdapter("external_test");
|
2026-04-04 14:04:33 -05:00
|
|
|
unregisterServerAdapter("claude_local");
|
|
|
|
|
setOverridePaused("claude_local", false);
|
2026-03-31 20:21:13 +01:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
unregisterServerAdapter("external_test");
|
2026-04-04 14:04:33 -05:00
|
|
|
unregisterServerAdapter("claude_local");
|
|
|
|
|
setOverridePaused("claude_local", false);
|
2026-03-31 20:21:13 +01:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("registers external adapters and exposes them through lookup helpers", async () => {
|
|
|
|
|
expect(findServerAdapter("external_test")).toBeNull();
|
|
|
|
|
|
|
|
|
|
registerServerAdapter(externalAdapter);
|
|
|
|
|
|
|
|
|
|
expect(requireServerAdapter("external_test")).toBe(externalAdapter);
|
|
|
|
|
expect(await listAdapterModels("external_test")).toEqual([
|
|
|
|
|
{ id: "external-model", label: "External Model" },
|
|
|
|
|
]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("removes external adapters when unregistered", () => {
|
|
|
|
|
registerServerAdapter(externalAdapter);
|
|
|
|
|
|
|
|
|
|
unregisterServerAdapter("external_test");
|
|
|
|
|
|
|
|
|
|
expect(findServerAdapter("external_test")).toBeNull();
|
|
|
|
|
expect(() => requireServerAdapter("external_test")).toThrow(
|
|
|
|
|
"Unknown adapter type: external_test",
|
|
|
|
|
);
|
|
|
|
|
});
|
2026-04-03 22:17:34 +01:00
|
|
|
|
|
|
|
|
it("allows external plugin to override a built-in adapter type", () => {
|
|
|
|
|
// claude_local is always built-in
|
|
|
|
|
const builtIn = findServerAdapter("claude_local");
|
|
|
|
|
expect(builtIn).not.toBeNull();
|
|
|
|
|
|
|
|
|
|
const plugin: ServerAdapterModule = {
|
|
|
|
|
type: "claude_local",
|
|
|
|
|
execute: async () => ({
|
|
|
|
|
exitCode: 0,
|
|
|
|
|
signal: null,
|
|
|
|
|
timedOut: false,
|
|
|
|
|
}),
|
|
|
|
|
testEnvironment: async () => ({
|
|
|
|
|
adapterType: "claude_local",
|
|
|
|
|
status: "pass",
|
|
|
|
|
checks: [],
|
|
|
|
|
testedAt: new Date(0).toISOString(),
|
|
|
|
|
}),
|
|
|
|
|
models: [{ id: "plugin-model", label: "Plugin Override" }],
|
|
|
|
|
supportsLocalAgentJwt: false,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
registerServerAdapter(plugin);
|
|
|
|
|
|
|
|
|
|
// Plugin wins
|
|
|
|
|
const resolved = requireServerAdapter("claude_local");
|
|
|
|
|
expect(resolved).toBe(plugin);
|
|
|
|
|
expect(resolved.models).toEqual([
|
|
|
|
|
{ id: "plugin-model", label: "Plugin Override" },
|
|
|
|
|
]);
|
|
|
|
|
});
|
2026-04-04 14:04:33 -05: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>
2026-04-15 08:10:52 -04:00
|
|
|
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);
|
|
|
|
|
});
|
|
|
|
|
|
2026-04-04 14:04:33 -05:00
|
|
|
it("switches active adapter behavior back to the builtin when an override is paused", async () => {
|
|
|
|
|
const builtIn = findServerAdapter("claude_local");
|
|
|
|
|
expect(builtIn).not.toBeNull();
|
|
|
|
|
|
|
|
|
|
const detectModel = vi.fn(async () => ({
|
|
|
|
|
model: "plugin-model",
|
|
|
|
|
provider: "plugin-provider",
|
|
|
|
|
source: "plugin-source",
|
|
|
|
|
}));
|
|
|
|
|
const plugin: ServerAdapterModule = {
|
|
|
|
|
type: "claude_local",
|
|
|
|
|
execute: async () => ({
|
|
|
|
|
exitCode: 0,
|
|
|
|
|
signal: null,
|
|
|
|
|
timedOut: false,
|
|
|
|
|
}),
|
|
|
|
|
testEnvironment: async () => ({
|
|
|
|
|
adapterType: "claude_local",
|
|
|
|
|
status: "pass",
|
|
|
|
|
checks: [],
|
|
|
|
|
testedAt: new Date(0).toISOString(),
|
|
|
|
|
}),
|
|
|
|
|
models: [{ id: "plugin-model", label: "Plugin Override" }],
|
|
|
|
|
detectModel,
|
|
|
|
|
supportsLocalAgentJwt: false,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
registerServerAdapter(plugin);
|
|
|
|
|
|
|
|
|
|
expect(findActiveServerAdapter("claude_local")).toBe(plugin);
|
|
|
|
|
expect(await listAdapterModels("claude_local")).toEqual([
|
|
|
|
|
{ id: "plugin-model", label: "Plugin Override" },
|
|
|
|
|
]);
|
|
|
|
|
expect(await detectAdapterModel("claude_local")).toMatchObject({
|
|
|
|
|
model: "plugin-model",
|
|
|
|
|
provider: "plugin-provider",
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(setOverridePaused("claude_local", true)).toBe(true);
|
|
|
|
|
|
|
|
|
|
expect(findActiveServerAdapter("claude_local")).not.toBe(plugin);
|
|
|
|
|
expect(await listAdapterModels("claude_local")).toEqual(builtIn?.models ?? []);
|
|
|
|
|
expect(await detectAdapterModel("claude_local")).toBeNull();
|
|
|
|
|
expect(detectModel).toHaveBeenCalledTimes(1);
|
|
|
|
|
});
|
2026-03-31 20:21:13 +01:00
|
|
|
});
|