mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-20 15:09:57 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The Skills Manager gives operators a reusable skill layer, but iteration still required manual edits, ad hoc prompts, and indirect run inspection. > - Skill authors need a focused workflow for editing skill files, saving representative test inputs, and running those inputs through an agent without exposing harness tasks as normal company work. > - The backend therefore needs durable test inputs, reusable run templates, hidden harness issues, scoped run execution, retention metadata, and read-containment rules around hidden work. > - The frontend needs a three-pane Studio that keeps skill files, saved inputs/templates, and run output/history visible together while preserving the existing design system and token rules. > - This pull request ships that Skill Studio surface end to end: database migrations, shared contracts, server APIs/services, hidden harness execution behavior, UI routes/components, and focused tests. > - The benefit is faster and safer skill iteration, with inspectable outputs and fewer ways for internal harness work to leak into normal task lists, costs, or adjacent read APIs. ## Linked Issues or Issue Description No public GitHub issue exists for this feature. Feature request summary: - Problem: Skill authors need to edit and test company skills in one place instead of switching between the skill detail page, task creation, run output, and manual prompt history. - Proposed solution: Add a Skill Studio workbench with saved inputs, reusable templates, hidden sandboxed test runs, live run status, output inspection, run history, rerun/delete controls, and frontmatter-aware editing. - Expected users: Paperclip operators and agent-company maintainers who create, fork, import, and tune skills. - Related public PRs: Supersedes #9205, which was replaced so the public PR branch name follows contributor policy. - Duplicate search: searched public GitHub issues and PRs for "Skill Studio"; no other active public issue or PR directly covers this feature. ## What Changed - Added database migrations for Skill Studio test inputs, test runs, test run retention, and reusable run templates. - Added shared Skill Studio types, validators, route helpers, frontmatter utilities, and status handling. - Added server services and routes for saved inputs, test runs, templates, reruns, terminal-run deletion, hidden harness issue execution, and run-detail hydration. - Strengthened hidden-issue read containment across issue-adjacent routes and cost rollups used by skill test harness work. - Added the Skill Studio UI with skill file editing, frontmatter editing, saved inputs, templates, run creation/cancel/rerun/delete flows, output rendering, history, route support, and responsive pane behavior. - Added focused backend, shared, and UI tests for the new APIs, routing logic, editor/run behavior, hidden-issue containment, and migration safety. - Rebased onto current `master`, removed the generated lockfile diff from the PR, and verified no workflow files are changed. ## Verification - [x] `pnpm --filter @paperclipai/db check:migrations` - [x] `pnpm check:token-gates` - [x] `pnpm exec vitest run server/src/__tests__/company-skills-service.test.ts server/src/__tests__/company-skills-routes.test.ts server/src/__tests__/company-skill-test-runs-service.test.ts ui/src/lib/skill-studio.test.ts ui/src/pages/SkillStudio.test.tsx` — 5 files, 132 tests passed - [x] Greptile review on the latest PR head - [x] GitHub PR checks on the latest PR head ## Risks - Medium risk because this is a broad feature touching database schema, server orchestration, issue visibility, and a large UI surface. - Hidden harness issue containment is security-sensitive; this PR includes regression coverage for adjacent read paths and cost rollups. - The new migrations are additive and use idempotent guards where applicable, but deployed databases that previously tested draft migration numbers should still be checked carefully. - The UI depends on a new resizable panels package in `ui/package.json`; the lockfile is intentionally left to repository automation. > 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 Codex, GPT-5 coding agent with shell, git, and GitHub CLI tool use. Earlier feature commits include assistance from other Paperclip coding agents; this PR preparation, rebase, cleanup commit, and PR body were completed by OpenAI Codex in a Paperclip worktree. ## 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> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
119 lines
3.7 KiB
TypeScript
119 lines
3.7 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import type { CompanySkillDetail } from "@paperclipai/shared";
|
|
import {
|
|
buildBlankSkillDraft,
|
|
buildForkSkillDraft,
|
|
defaultSkillMarkdown,
|
|
normalizeSkillDraftSlug,
|
|
skillCreateDraftToPayload,
|
|
splitCategoryDraft,
|
|
} from "./skill-create";
|
|
|
|
function skill(overrides: Partial<CompanySkillDetail> = {}): CompanySkillDetail {
|
|
return {
|
|
id: "skill-1",
|
|
companyId: "company-1",
|
|
key: "paperclip/demo-skill",
|
|
slug: "demo-skill",
|
|
name: "Demo Skill",
|
|
description: "A demo skill.",
|
|
markdown: "---\nname: Demo Skill\ndescription: Existing\n---\n\n# Demo Skill\n",
|
|
sourceType: "local_path",
|
|
sourceLocator: null,
|
|
sourceRef: null,
|
|
trustLevel: "markdown_only",
|
|
compatibility: "compatible",
|
|
fileInventory: [{ path: "SKILL.md", kind: "skill" }],
|
|
iconUrl: null,
|
|
color: null,
|
|
tagline: "Existing tagline",
|
|
authorName: null,
|
|
homepageUrl: null,
|
|
categories: ["engineering", "review"],
|
|
sharingScope: "company",
|
|
publicShareToken: null,
|
|
forkedFromSkillId: null,
|
|
forkedFromCompanyId: null,
|
|
starCount: 0,
|
|
installCount: 0,
|
|
forkCount: 0,
|
|
currentVersionId: null,
|
|
metadata: null,
|
|
createdAt: new Date("2026-01-01T00:00:00Z"),
|
|
updatedAt: new Date("2026-01-02T00:00:00Z"),
|
|
attachedAgentCount: 0,
|
|
usedByAgents: [],
|
|
editable: true,
|
|
editableReason: null,
|
|
sourceLabel: "Local",
|
|
sourceBadge: "local",
|
|
sourcePath: null,
|
|
currentVersion: null,
|
|
starredByCurrentActor: false,
|
|
existingForks: [],
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("skill create helpers", () => {
|
|
it("normalizes slugs and category drafts", () => {
|
|
expect(normalizeSkillDraftSlug(" My Fancy_SKILL!! ")).toBe("my-fancy-skill");
|
|
expect(splitCategoryDraft(" Review, memory tools, review, , Agent_QA ")).toEqual([
|
|
"Review",
|
|
"memory tools",
|
|
"Agent_QA",
|
|
]);
|
|
});
|
|
|
|
it("keeps commas as draft delimiters while allowing spaces inside category names", () => {
|
|
expect(splitCategoryDraft(" AI Tools, Developer Experience, ai tools, ")).toEqual([
|
|
"AI Tools",
|
|
"Developer Experience",
|
|
]);
|
|
});
|
|
|
|
it("builds blank drafts with default SKILL.md frontmatter", () => {
|
|
const draft = buildBlankSkillDraft();
|
|
|
|
expect(draft.name).toBe("");
|
|
expect(draft.slug).toBe("");
|
|
expect(draft.sharingScope).toBe("company");
|
|
expect(draft.markdown).toContain("name: New Skill");
|
|
expect(draft.markdown).toContain("Describe when agents should use this skill.");
|
|
});
|
|
|
|
it("builds fork drafts from the source skill metadata", () => {
|
|
const draft = buildForkSkillDraft(skill({ color: "#123456" }));
|
|
|
|
expect(draft.name).toBe("Demo Skill Fork");
|
|
expect(draft.slug).toBe("demo-skill-fork");
|
|
expect(draft.color).toBe("#123456");
|
|
expect(draft.categories).toEqual(["engineering", "review"]);
|
|
expect(draft.forkedFromSkillId).toBe("skill-1");
|
|
expect(draft.forkedFromName).toBe("Demo Skill");
|
|
expect(draft.markdown).toContain("name: Demo Skill Fork");
|
|
});
|
|
|
|
it("converts drafts to create payloads with fallback slug and markdown", () => {
|
|
const draft = {
|
|
...buildBlankSkillDraft(),
|
|
name: "Code Review",
|
|
tagline: "Review repository changes.",
|
|
markdown: "",
|
|
categories: ["review"],
|
|
sharingScope: "private" as const,
|
|
};
|
|
|
|
expect(skillCreateDraftToPayload(draft)).toMatchObject({
|
|
name: "Code Review",
|
|
slug: "code-review",
|
|
description: "Review repository changes.",
|
|
tagline: "Review repository changes.",
|
|
categories: ["review"],
|
|
sharingScope: "private",
|
|
forkedFromSkillId: null,
|
|
markdown: defaultSkillMarkdown("Code Review", "Review repository changes."),
|
|
});
|
|
});
|
|
});
|