mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-04 02:32:07 +01: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>
76 lines
2.6 KiB
TypeScript
76 lines
2.6 KiB
TypeScript
import type { AgentSkillEntry } from "@paperclipai/shared";
|
|
|
|
export interface AgentSkillDraftState {
|
|
draft: string[];
|
|
lastSaved: string[];
|
|
hasHydratedSnapshot: boolean;
|
|
}
|
|
|
|
export interface AgentSkillSnapshotApplyResult extends AgentSkillDraftState {
|
|
shouldSkipAutosave: boolean;
|
|
}
|
|
|
|
export function arraysEqual(a: string[], b: string[]): boolean {
|
|
if (a === b) return true;
|
|
if (a.length !== b.length) return false;
|
|
return a.every((value, index) => value === b[index]);
|
|
}
|
|
|
|
/**
|
|
* Order-independent equality for a desired-skill selection. A skill selection is
|
|
* conceptually a set, and the server may return keys in a different order than
|
|
* the client sent them (it canonicalizes references and re-groups stale keys).
|
|
* Comparing as sets keeps "is this saved?" honest across those reorderings —
|
|
* without it, a persisted-but-reordered response reads as "still dirty" and the
|
|
* autosave re-fires forever (a benign-looking sibling of the PAP-13222 storm).
|
|
*/
|
|
export function sameSkillSelection(a: string[], b: string[]): boolean {
|
|
const setA = new Set(a);
|
|
const setB = new Set(b);
|
|
if (setA.size !== setB.size) return false;
|
|
for (const key of setA) {
|
|
if (!setB.has(key)) return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
export function applyAgentSkillSnapshot(
|
|
state: AgentSkillDraftState,
|
|
desiredSkills: string[],
|
|
): AgentSkillSnapshotApplyResult {
|
|
const shouldReplaceDraft = !state.hasHydratedSnapshot || arraysEqual(state.draft, state.lastSaved);
|
|
|
|
return {
|
|
draft: shouldReplaceDraft ? desiredSkills : state.draft,
|
|
lastSaved: desiredSkills,
|
|
hasHydratedSnapshot: true,
|
|
shouldSkipAutosave: shouldReplaceDraft,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Decide whether the autosave effect should (re)schedule a sync for the current
|
|
* draft. Returns false when the draft is already saved, or when it exactly
|
|
* matches a payload that just failed — the latter is what prevents the infinite
|
|
* 422 retry storm (PAP-13222). A failed payload only becomes sendable again once
|
|
* the user edits the draft into something new.
|
|
*/
|
|
export function shouldScheduleSkillAutosave(params: {
|
|
draft: string[];
|
|
lastSaved: string[];
|
|
failedDraft: string[] | null;
|
|
}): boolean {
|
|
if (sameSkillSelection(params.draft, params.lastSaved)) return false;
|
|
if (params.failedDraft && sameSkillSelection(params.draft, params.failedDraft)) return false;
|
|
return true;
|
|
}
|
|
|
|
export function isReadOnlyUnmanagedSkillEntry(
|
|
entry: AgentSkillEntry,
|
|
companySkillKeys: Set<string>,
|
|
): boolean {
|
|
if (companySkillKeys.has(entry.key)) return false;
|
|
if (entry.origin === "user_installed" || entry.origin === "external_unknown") return true;
|
|
return entry.managed === false && entry.state === "external";
|
|
}
|