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>
243 lines
8.3 KiB
TypeScript
243 lines
8.3 KiB
TypeScript
import { z } from "zod";
|
|
|
|
export const companySkillSourceTypeSchema = z.enum(["local_path", "github", "url", "catalog", "skills_sh"]);
|
|
export const companySkillTrustLevelSchema = z.enum(["markdown_only", "assets", "scripts_executables"]);
|
|
export const companySkillCompatibilitySchema = z.enum(["compatible", "unknown", "invalid"]);
|
|
export const companySkillSourceBadgeSchema = z.enum(["paperclip", "github", "local", "url", "catalog", "skills_sh"]);
|
|
|
|
export const companySkillFileInventoryEntrySchema = z.object({
|
|
path: z.string().min(1),
|
|
kind: z.enum(["skill", "markdown", "reference", "script", "asset", "other"]),
|
|
});
|
|
|
|
export const companySkillSchema = z.object({
|
|
id: z.string().uuid(),
|
|
companyId: z.string().uuid(),
|
|
key: z.string().min(1),
|
|
slug: z.string().min(1),
|
|
name: z.string().min(1),
|
|
description: z.string().nullable(),
|
|
markdown: z.string(),
|
|
sourceType: companySkillSourceTypeSchema,
|
|
sourceLocator: z.string().nullable(),
|
|
sourceRef: z.string().nullable(),
|
|
trustLevel: companySkillTrustLevelSchema,
|
|
compatibility: companySkillCompatibilitySchema,
|
|
fileInventory: z.array(companySkillFileInventoryEntrySchema).default([]),
|
|
metadata: z.record(z.string(), z.unknown()).nullable(),
|
|
createdAt: z.coerce.date(),
|
|
updatedAt: z.coerce.date(),
|
|
});
|
|
|
|
export const companySkillListItemSchema = companySkillSchema.extend({
|
|
attachedAgentCount: z.number().int().nonnegative(),
|
|
editable: z.boolean(),
|
|
editableReason: z.string().nullable(),
|
|
sourceLabel: z.string().nullable(),
|
|
sourceBadge: companySkillSourceBadgeSchema,
|
|
catalogKind: z.enum(["bundled", "optional"]).nullable(),
|
|
originHash: z.string().nullable(),
|
|
packageName: z.string().nullable(),
|
|
packageVersion: z.string().nullable(),
|
|
});
|
|
|
|
export const companySkillUsageAgentSchema = z.object({
|
|
id: z.string().uuid(),
|
|
name: z.string().min(1),
|
|
urlKey: z.string().min(1),
|
|
adapterType: z.string().min(1),
|
|
desired: z.boolean(),
|
|
actualState: z.string().nullable().describe(
|
|
"Runtime adapter skill state when explicitly fetched; company skill detail reads return null without probing agent runtimes.",
|
|
),
|
|
});
|
|
|
|
export const companySkillDetailSchema = companySkillSchema.extend({
|
|
attachedAgentCount: z.number().int().nonnegative(),
|
|
usedByAgents: z.array(companySkillUsageAgentSchema).default([]),
|
|
editable: z.boolean(),
|
|
editableReason: z.string().nullable(),
|
|
sourceLabel: z.string().nullable(),
|
|
sourceBadge: companySkillSourceBadgeSchema,
|
|
});
|
|
|
|
export const companySkillUpdateStatusSchema = z.object({
|
|
supported: z.boolean(),
|
|
reason: z.string().nullable(),
|
|
trackingRef: z.string().nullable(),
|
|
currentRef: z.string().nullable(),
|
|
latestRef: z.string().nullable(),
|
|
hasUpdate: z.boolean(),
|
|
installedHash: z.string().nullable(),
|
|
originHash: z.string().nullable(),
|
|
userModifiedAt: z.string().nullable(),
|
|
updateHoldReason: z.enum([
|
|
"local_modifications",
|
|
"audit_hard_stop",
|
|
"origin_unavailable",
|
|
"compatibility_invalid",
|
|
"operator_hold",
|
|
]).nullable(),
|
|
auditVerdict: z.enum(["pass", "warning", "fail"]).nullable(),
|
|
auditCodes: z.array(z.string()),
|
|
});
|
|
|
|
export const companySkillAuditFindingSchema = z.object({
|
|
code: z.string().min(1),
|
|
severity: z.enum(["warning", "error"]),
|
|
message: z.string().min(1),
|
|
path: z.string().nullable(),
|
|
});
|
|
|
|
export const companySkillAuditResultSchema = z.object({
|
|
skillId: z.string().uuid(),
|
|
installedHash: z.string().nullable(),
|
|
originHash: z.string().nullable(),
|
|
verdict: z.enum(["pass", "warning", "fail"]),
|
|
codes: z.array(z.string()),
|
|
findings: z.array(companySkillAuditFindingSchema),
|
|
scannedAt: z.string().min(1),
|
|
scanVersion: z.string().min(1),
|
|
});
|
|
|
|
export const companySkillInstallUpdateSchema = z.object({
|
|
force: z.boolean().optional(),
|
|
}).default({});
|
|
|
|
export const companySkillResetSchema = z.object({
|
|
force: z.boolean().optional(),
|
|
}).default({});
|
|
|
|
export const companySkillImportSchema = z.object({
|
|
source: z.string().min(1),
|
|
});
|
|
|
|
export const companySkillProjectScanRequestSchema = z.object({
|
|
projectIds: z.array(z.string().uuid()).optional(),
|
|
workspaceIds: z.array(z.string().uuid()).optional(),
|
|
});
|
|
|
|
export const companySkillProjectScanSkippedSchema = z.object({
|
|
projectId: z.string().uuid(),
|
|
projectName: z.string().min(1),
|
|
workspaceId: z.string().uuid().nullable(),
|
|
workspaceName: z.string().nullable(),
|
|
path: z.string().nullable(),
|
|
reason: z.string().min(1),
|
|
});
|
|
|
|
export const companySkillProjectScanConflictSchema = z.object({
|
|
slug: z.string().min(1),
|
|
key: z.string().min(1),
|
|
projectId: z.string().uuid(),
|
|
projectName: z.string().min(1),
|
|
workspaceId: z.string().uuid(),
|
|
workspaceName: z.string().min(1),
|
|
path: z.string().min(1),
|
|
existingSkillId: z.string().uuid(),
|
|
existingSkillKey: z.string().min(1),
|
|
existingSourceLocator: z.string().nullable(),
|
|
reason: z.string().min(1),
|
|
});
|
|
|
|
export const companySkillProjectScanResultSchema = z.object({
|
|
scannedProjects: z.number().int().nonnegative(),
|
|
scannedWorkspaces: z.number().int().nonnegative(),
|
|
discovered: z.number().int().nonnegative(),
|
|
imported: z.array(companySkillSchema),
|
|
updated: z.array(companySkillSchema),
|
|
skipped: z.array(companySkillProjectScanSkippedSchema),
|
|
conflicts: z.array(companySkillProjectScanConflictSchema),
|
|
warnings: z.array(z.string()),
|
|
});
|
|
|
|
export const companySkillCreateSchema = z.object({
|
|
name: z.string().min(1),
|
|
slug: z.string().min(1).nullable().optional(),
|
|
description: z.string().nullable().optional(),
|
|
markdown: z.string().nullable().optional(),
|
|
});
|
|
|
|
export const companySkillFileDetailSchema = z.object({
|
|
skillId: z.string().uuid(),
|
|
path: z.string().min(1),
|
|
kind: z.enum(["skill", "markdown", "reference", "script", "asset", "other"]),
|
|
content: z.string(),
|
|
language: z.string().nullable(),
|
|
markdown: z.boolean(),
|
|
editable: z.boolean(),
|
|
});
|
|
|
|
export const companySkillFileUpdateSchema = z.object({
|
|
path: z.string().min(1),
|
|
content: z.string(),
|
|
});
|
|
|
|
export const catalogSkillKindSchema = z.enum(["bundled", "optional"]);
|
|
|
|
export const catalogSkillFileSchema = z.object({
|
|
path: z.string().min(1),
|
|
kind: z.enum(["skill", "markdown", "reference", "script", "asset", "other"]),
|
|
sizeBytes: z.number().int().nonnegative(),
|
|
sha256: z.string().min(1),
|
|
});
|
|
|
|
export const catalogSkillSchema = z.object({
|
|
id: z.string().min(1),
|
|
key: z.string().min(1),
|
|
kind: catalogSkillKindSchema,
|
|
category: z.string().min(1),
|
|
slug: z.string().min(1),
|
|
name: z.string().min(1),
|
|
description: z.string(),
|
|
path: z.string().min(1),
|
|
entrypoint: z.literal("SKILL.md"),
|
|
trustLevel: companySkillTrustLevelSchema,
|
|
compatibility: companySkillCompatibilitySchema,
|
|
defaultInstall: z.boolean(),
|
|
recommendedForRoles: z.array(z.string()),
|
|
requires: z.array(z.string()),
|
|
tags: z.array(z.string()),
|
|
files: z.array(catalogSkillFileSchema),
|
|
contentHash: z.string().min(1),
|
|
packageName: z.string().min(1).optional(),
|
|
packageVersion: z.string().min(1).optional(),
|
|
});
|
|
|
|
export const catalogSkillListQuerySchema = z.object({
|
|
kind: catalogSkillKindSchema.optional(),
|
|
category: z.string().min(1).optional(),
|
|
q: z.string().min(1).optional(),
|
|
});
|
|
|
|
export const catalogSkillFileDetailSchema = z.object({
|
|
catalogSkillId: z.string().min(1),
|
|
path: z.string().min(1),
|
|
kind: z.enum(["skill", "markdown", "reference", "script", "asset", "other"]),
|
|
content: z.string(),
|
|
language: z.string().nullable(),
|
|
markdown: z.boolean(),
|
|
});
|
|
|
|
export const companySkillInstallCatalogSchema = z.object({
|
|
catalogSkillId: z.string().min(1),
|
|
slug: z.string().min(1).nullable().optional(),
|
|
force: z.boolean().optional(),
|
|
});
|
|
|
|
export const companySkillInstallCatalogResultSchema = z.object({
|
|
action: z.enum(["created", "updated", "unchanged"]),
|
|
skill: companySkillSchema,
|
|
catalogSkill: catalogSkillSchema,
|
|
warnings: z.array(z.string()),
|
|
});
|
|
|
|
export type CompanySkillImport = z.infer<typeof companySkillImportSchema>;
|
|
export type CompanySkillProjectScan = z.infer<typeof companySkillProjectScanRequestSchema>;
|
|
export type CompanySkillCreate = z.infer<typeof companySkillCreateSchema>;
|
|
export type CompanySkillFileUpdate = z.infer<typeof companySkillFileUpdateSchema>;
|
|
export type CatalogSkillListQuery = z.infer<typeof catalogSkillListQuerySchema>;
|
|
export type CompanySkillInstallCatalog = z.infer<typeof companySkillInstallCatalogSchema>;
|
|
export type CompanySkillInstallUpdate = z.infer<typeof companySkillInstallUpdateSchema>;
|
|
export type CompanySkillReset = z.infer<typeof companySkillResetSchema>;
|