9eac727cf1
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies through company-scoped control-plane workflows. > - Agents need reusable, inspectable skills that can be installed, reset, audited, exported, and assigned without bespoke local setup. > - The existing skill truth model needed cleanup so bundled skills, optional catalog skills, runtime skills, and adapter-provided skills have clear provenance. > - Operators also need a practical CLI and board UI for discovering and managing company skills. > - This pull request adds the skills CLI, packaged skills catalog, company skills APIs, and catalog-aware board UI. > - The benefit is a more reusable Paperclip company setup where skills are portable, auditable, and easier for operators and agents to manage. ## What Changed - Added `paperclipai skills` CLI commands and coverage for catalog listing, installing, resetting, and inspecting company skills. - Added a packaged `@paperclipai/skills-catalog` workspace with bundled and optional skill content plus validation/build tests. - Added shared company-skill types and validators used across CLI, server, and UI contracts. - Added server catalog APIs/services for company skill catalog operations, reset semantics, audit behavior, and portability provenance. - Updated adapter skill handling so runtime/catalog provenance remains explicit across local adapters. - Added board UI support for browsing and managing catalog-backed company skills. - Updated docs for the skills CLI/catalog flow and the company skills Paperclip skill reference. - Rebased the branch onto current `paperclipai/paperclip:master`; no `pnpm-lock.yaml`, `.github/workflows`, or migration files are included in the final PR diff. ## Verification - Passed: `pnpm run preflight:workspace-links && pnpm exec vitest run cli/src/__tests__/skills.test.ts packages/skills-catalog/src/catalog-builder.test.ts packages/skills-catalog/src/shipped-catalog.test.ts packages/shared/src/validators/company-skill.test.ts packages/adapter-utils/src/server-utils.test.ts packages/plugins/create-paperclip-plugin/src/entrypoints.test.ts server/src/__tests__/company-skills-catalog-service.test.ts server/src/__tests__/company-skills-routes.test.ts server/src/__tests__/company-portability.test.ts`. - Passed: `pnpm exec vitest run server/src/__tests__/workspace-runtime.test.ts -t "default branch|origin/master|symbolic-ref"`. - Attempted: full `server/src/__tests__/workspace-runtime.test.ts`. Four provisioning tests failed while seeding an isolated worktree database from the local Paperclip instance because the local plugin schema dump contains a duplicate-column foreign key (`plugin_content_machine_18a7bc327b.content_case_signals`). The default-branch tests touched by the rebase conflict passed in the focused run above. - Checked final diff: no `pnpm-lock.yaml`, no `.github/workflows`, and no migration-file changes relative to `master`. ## Risks - Medium: this is a broad skills/catalog change touching CLI, server APIs, shared contracts, adapter skill sync, and UI. - Catalog validation and reset semantics need careful reviewer attention because they affect reusable company setup and portability. - No database migrations are included in this PR, so there is no migration ordering/idempotency risk in the final diff. - No lockfile is included by design; dependency resolution will be handled by the repository lockfile workflow. ## Model Used - OpenAI Codex coding agent based on GPT-5, running in Paperclip via the `codex_local` adapter with shell, git, GitHub CLI, and code-editing tool access. Exact hosted model build/context-window metadata is not exposed in this runtime. ## 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 run targeted tests locally and documented the local workspace-runtime seed failure above - [x] I have added or updated tests where applicable - [x] If this change affects the UI, screenshots were intentionally omitted per PAP-10124 instructions; UI behavior is covered by tests and reviewer inspection - [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: Paperclip <noreply@paperclip.ing>
114 lines
3.8 KiB
TypeScript
114 lines
3.8 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
import type { CatalogSkill } from "@paperclipai/shared";
|
|
|
|
const mockExistsSync = vi.hoisted(() => vi.fn());
|
|
const mockReadFileSync = vi.hoisted(() => vi.fn());
|
|
const mockStatSync = vi.hoisted(() => vi.fn());
|
|
const mockReadFile = vi.hoisted(() => vi.fn());
|
|
|
|
vi.doMock("node:fs", async () => {
|
|
const actual = await vi.importActual<typeof import("node:fs")>("node:fs");
|
|
return {
|
|
...actual,
|
|
existsSync: mockExistsSync,
|
|
readFileSync: mockReadFileSync,
|
|
statSync: mockStatSync,
|
|
promises: {
|
|
...actual.promises,
|
|
readFile: mockReadFile,
|
|
},
|
|
};
|
|
});
|
|
|
|
function catalogSkill(slug: string, name = slug): CatalogSkill {
|
|
return {
|
|
id: `paperclipai:bundled:software-development:${slug}`,
|
|
key: `paperclipai/bundled/software-development/${slug}`,
|
|
kind: "bundled",
|
|
category: "software-development",
|
|
slug,
|
|
name,
|
|
description: `${name} catalog skill used by the reload test.`,
|
|
path: `catalog/bundled/software-development/${slug}`,
|
|
entrypoint: "SKILL.md",
|
|
trustLevel: "markdown_only",
|
|
compatibility: "compatible",
|
|
defaultInstall: false,
|
|
recommendedForRoles: ["engineer"],
|
|
requires: [],
|
|
tags: ["test"],
|
|
files: [{ path: "SKILL.md", kind: "skill", sizeBytes: 8, sha256: `sha256:${slug}` }],
|
|
contentHash: `sha256:${slug}`,
|
|
};
|
|
}
|
|
|
|
function manifest(skills: CatalogSkill[], packageVersion = "0.3.1") {
|
|
return JSON.stringify({
|
|
schemaVersion: 1,
|
|
packageName: "@paperclipai/skills-catalog",
|
|
packageVersion,
|
|
generatedAt: "2026-05-28T00:00:00.000Z",
|
|
skills,
|
|
});
|
|
}
|
|
|
|
describe("skills catalog service", () => {
|
|
let manifestJson: string;
|
|
let manifestMtimeMs: number;
|
|
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.clearAllMocks();
|
|
manifestJson = manifest([catalogSkill("old-skill", "Old Skill")]);
|
|
manifestMtimeMs = 1;
|
|
mockExistsSync.mockReturnValue(true);
|
|
mockReadFileSync.mockImplementation(() => manifestJson);
|
|
mockStatSync.mockImplementation(() => ({
|
|
mtimeMs: manifestMtimeMs,
|
|
size: Buffer.byteLength(manifestJson),
|
|
}));
|
|
mockReadFile.mockImplementation(async (filePath: string) => `content:${filePath}`);
|
|
});
|
|
|
|
it("caches and reloads the generated catalog manifest when it changes", async () => {
|
|
const service = await import("../services/skills-catalog.js");
|
|
|
|
expect(service.listCatalogSkills().map((skill) => skill.key)).toEqual([
|
|
"paperclipai/bundled/software-development/old-skill",
|
|
]);
|
|
expect(service.listCatalogSkills().map((skill) => skill.key)).toEqual([
|
|
"paperclipai/bundled/software-development/old-skill",
|
|
]);
|
|
expect(mockReadFileSync).toHaveBeenCalledTimes(1);
|
|
|
|
manifestJson = manifest([catalogSkill("new-skill", "New Skill")], "0.3.2");
|
|
manifestMtimeMs += 1;
|
|
|
|
expect(service.listCatalogSkills().map((skill) => skill.key)).toEqual([
|
|
"paperclipai/bundled/software-development/new-skill",
|
|
]);
|
|
expect(mockReadFileSync).toHaveBeenCalledTimes(2);
|
|
expect(() => service.getCatalogSkillOrThrow("old-skill")).toThrow("Catalog skill not found");
|
|
expect(service.getCatalogPackageMetadata()).toEqual({
|
|
packageName: "@paperclipai/skills-catalog",
|
|
packageVersion: "0.3.2",
|
|
});
|
|
});
|
|
|
|
it("rejects catalog asset previews without decoding bytes as utf8", async () => {
|
|
const imageSkill = catalogSkill("with-image", "With Image");
|
|
imageSkill.files = [
|
|
...imageSkill.files,
|
|
{ path: "assets/logo.png", kind: "asset", sizeBytes: 4, sha256: "sha256:logo" },
|
|
];
|
|
manifestJson = manifest([imageSkill]);
|
|
const service = await import("../services/skills-catalog.js");
|
|
|
|
await expect(service.readCatalogSkillFile(imageSkill.id, "assets/logo.png")).rejects.toMatchObject({
|
|
status: 415,
|
|
message: "Catalog asset previews are not supported.",
|
|
});
|
|
expect(mockReadFile).not.toHaveBeenCalled();
|
|
});
|
|
});
|