mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-15 20:53:23 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Agents can select company skills and synchronize them to adapter runtimes > - The skill sync API replaced the complete selection without an explicit destructive choice > - Company package import also replaced conflicting skills by default > - These defaults could remove operator edits during setup and import reruns > - This pull request adds explicit assignment merge modes and safe package conflict handling > - The benefit is that reruns preserve operator work unless the caller explicitly requests replacement ## Linked Issues or Issue Description **What existing behavior does this improve?** This change improves agent skill synchronization and company package import. **Subsystem affected** This is a cross-cutting change across the shared contracts, server, CLI, and UI. **Current behavior** Agent skill synchronization replaces the full desired skill set from a modeless request. Package import replaces a conflicting skill when the caller does not select a conflict mode. **Proposed behavior** Agent skill synchronization requires `add`, `remove`, or `replace`. Package import skips conflicts by default. Each imported skill reports whether it was created, renamed, replaced, or skipped. **Reason and benefit** Setup and import reruns must preserve operator edits by default. Explicit destructive modes make data loss less likely and make each outcome inspectable. **Breaking changes** Callers of the agent skill sync API must now send `mode`. Callers that need the former behavior must send `replace`. Package import now uses `skip` when `onConflict` is absent. ## What Changed - Added required `add`, `remove`, and `replace` modes to the shared agent skill sync contract. - Added actionable `422` validation for missing or invalid modes. - Updated first-party UI and CLI callers with explicit modes. - Changed package skill conflict handling to use `skip` by default. - Kept plugin-owned and built-in stock skill imports on explicit `replace`. - Added created, renamed, replaced, and skipped results to company imports. - Added regression coverage for merge modes and package conflict outcomes. ## Verification - `pnpm check:token-gates` - `pnpm -r typecheck` - `pnpm build` - `pnpm test:run:serialized` (128 suites passed) - `pnpm --filter @paperclipai/skills-catalog test` (20 tests passed) - Focused agent skill route, company skill service, portability, CLI, and UI tests passed. - GitHub CI passed build, typecheck, canary, all general and serialized test shards, all browser shards, policy, security, and final verification on commit `2cfbb3e4c5`. - Greptile reviewed the latest commit at 5/5 with zero unresolved threads. ## Risks - This change intentionally rejects modeless agent skill sync requests. - The safe package default can leave an existing skill unchanged where the old default overwrote it. - All first-party callers now select a mode. Regression tests cover each outcome. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI `gpt-5.6-sol` through Codex. The runtime used agentic reasoning, tool use, code execution, and repository editing. The runtime did not expose the context window size. ## 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 checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
126 lines
5.9 KiB
TypeScript
126 lines
5.9 KiB
TypeScript
import { Command } from "commander";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { registerAgentCommands } from "../commands/client/agent.js";
|
|
|
|
const COMPANY_ID = "22222222-2222-4222-8222-222222222222";
|
|
const AGENT_ID = "11111111-1111-4111-8111-111111111111";
|
|
const REVISION_ID = "33333333-3333-4333-8333-333333333333";
|
|
|
|
function createProgram(): Command {
|
|
const program = new Command();
|
|
program.exitOverride();
|
|
program.configureOutput({
|
|
writeOut: () => {},
|
|
writeErr: () => {},
|
|
});
|
|
registerAgentCommands(program);
|
|
return program;
|
|
}
|
|
|
|
async function run(args: string[]): Promise<void> {
|
|
await createProgram().parseAsync([
|
|
...args,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
}
|
|
|
|
describe("agent lifecycle commands", () => {
|
|
beforeEach(() => {
|
|
vi.restoreAllMocks();
|
|
delete process.env.PAPERCLIP_API_KEY;
|
|
delete process.env.PAPERCLIP_API_URL;
|
|
vi.spyOn(console, "log").mockImplementation(() => {});
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("wraps agent lifecycle and state endpoints", async () => {
|
|
const fetchMock = vi.fn().mockImplementation(() => Promise.resolve(jsonResponse()));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run([
|
|
"agent", "create",
|
|
"--company-id", COMPANY_ID,
|
|
"--payload-json", JSON.stringify({ name: "Builder", adapterType: "codex_local" }),
|
|
]);
|
|
await run(["agent", "hire", "--company-id", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["agent", "update", AGENT_ID, "--payload-json", JSON.stringify({ title: "Senior Builder" })]);
|
|
await run(["agent", "pause", AGENT_ID]);
|
|
await run(["agent", "resume", AGENT_ID]);
|
|
await run(["agent", "approve", AGENT_ID]);
|
|
await run(["agent", "terminate", AGENT_ID]);
|
|
await run(["agent", "heartbeat:invoke", AGENT_ID]);
|
|
await run(["agent", "claude-login", AGENT_ID]);
|
|
await run(["agent", "delete", AGENT_ID, "--yes"]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/agents`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/agent-hires`],
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/pause`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/resume`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/approve`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/terminate`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/heartbeat/invoke`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/claude-login`],
|
|
["DELETE", `http://localhost:3100/api/agents/${AGENT_ID}`],
|
|
]);
|
|
});
|
|
|
|
it("wraps configuration, runtime, skills, and instructions endpoints", async () => {
|
|
const fetchMock = vi.fn().mockImplementation(() => Promise.resolve(jsonResponse()));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run(["agent", "permissions:update", AGENT_ID, "--payload-json", JSON.stringify({ canCreateAgents: true, canAssignTasks: true })]);
|
|
await run(["agent", "configuration", AGENT_ID]);
|
|
await run(["agent", "config-revisions", AGENT_ID]);
|
|
await run(["agent", "config-revision:get", AGENT_ID, REVISION_ID]);
|
|
await run(["agent", "config-revision:rollback", AGENT_ID, REVISION_ID]);
|
|
await run(["agent", "runtime-state", AGENT_ID]);
|
|
await run(["agent", "runtime-state:reset-session", AGENT_ID, "--task-key", "task-1"]);
|
|
await run(["agent", "task-sessions", AGENT_ID]);
|
|
await run(["agent", "skills", AGENT_ID]);
|
|
await run([
|
|
"agent",
|
|
"skills:sync",
|
|
AGENT_ID,
|
|
"--desired-skills",
|
|
"paperclip,github",
|
|
"--mode",
|
|
"replace",
|
|
]);
|
|
await run(["agent", "instructions-path:update", AGENT_ID, "--payload-json", JSON.stringify({ path: "/tmp/AGENTS.md" })]);
|
|
await run(["agent", "instructions-bundle", AGENT_ID]);
|
|
await run(["agent", "instructions-bundle:update", AGENT_ID, "--payload-json", JSON.stringify({ mode: "managed" })]);
|
|
await run(["agent", "instructions-file:get", AGENT_ID, "--path", "AGENTS.md"]);
|
|
await run(["agent", "instructions-file:put", AGENT_ID, "--path", "AGENTS.md", "--content", "hello"]);
|
|
await run(["agent", "instructions-file:delete", AGENT_ID, "--path", "AGENTS.md"]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}/permissions`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/configuration`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/config-revisions`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/config-revisions/${REVISION_ID}`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/config-revisions/${REVISION_ID}/rollback`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/runtime-state`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/runtime-state/reset-session`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/task-sessions`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/skills`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/skills/sync`],
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-path`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle`],
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle/file?path=AGENTS.md`],
|
|
["PUT", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle/file`],
|
|
["DELETE", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle/file?path=AGENTS.md`],
|
|
]);
|
|
});
|
|
});
|
|
|
|
function jsonResponse(body: unknown = { ok: true }, init: ResponseInit = { status: 200 }): Response {
|
|
return new Response(JSON.stringify(body), init);
|
|
}
|