forked from farhoodlabs/paperclip
641eb44949
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - Hiring agents is a governance-sensitive workflow because it grants roles, adapter config, skills, and execution capability > - The create-agent skill needs explicit templates and review guidance so hires are auditable and not over-permissioned > - Skill sync also needs to recognize bundled Paperclip skills consistently for Codex local agents > - This pull request expands create-agent role templates, adds a security-engineer template, and documents capability/secret-handling review requirements > - The benefit is safer, more repeatable agent creation with clearer approval payloads and less permission sprawl ## What Changed - Expanded `paperclip-create-agent` guidance for template selection, adjacent-template drafting, and role-specific review bars. - Added a Security Engineer agent template and collaboration/safety sections for Coder, QA, and UX Designer templates. - Hardened draft-review guidance around desired skills, external-system access, secrets, and confidential advisory handling. - Updated LLM agent-configuration guidance to point hiring workflows at the create-agent skill. - Added tests for bundled skill sync, create-agent skill injection, hire approval payloads, and LLM route guidance. ## Verification - `pnpm exec vitest run server/src/__tests__/agent-skills-routes.test.ts server/src/__tests__/codex-local-skill-injection.test.ts server/src/__tests__/codex-local-skill-sync.test.ts server/src/__tests__/llms-routes.test.ts server/src/__tests__/paperclip-skill-utils.test.ts --config server/vitest.config.ts` passed: 5 files, 23 tests. - `git diff --check public-gh/master..pap-2228-create-agent-governance -- . ':(exclude)ui/storybook-static'` passed. - Confirmed this PR does not include `pnpm-lock.yaml`. ## Risks - Low-to-medium risk: this primarily changes skills/docs and tests, but it affects future hiring guidance and approval expectations. - Reviewers should check whether the new Security Engineer template is too broad for default company installs. - No database migrations. > 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 coding agent based on GPT-5, with shell, git, Paperclip API, and GitHub CLI tool use in the local Paperclip workspace. ## 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 tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [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 Note: screenshot checklist item is not applicable; this PR changes skills, docs, and server tests. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
193 lines
7.2 KiB
TypeScript
193 lines
7.2 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { afterEach, describe, expect, it } from "vitest";
|
|
import { ensureCodexSkillsInjected } from "@paperclipai/adapter-codex-local/server";
|
|
|
|
async function makeTempDir(prefix: string): Promise<string> {
|
|
return fs.mkdtemp(path.join(os.tmpdir(), prefix));
|
|
}
|
|
|
|
async function createPaperclipRepoSkill(root: string, skillName: string) {
|
|
await fs.mkdir(path.join(root, "server"), { recursive: true });
|
|
await fs.mkdir(path.join(root, "packages", "adapter-utils"), { recursive: true });
|
|
await fs.mkdir(path.join(root, "skills", skillName), { recursive: true });
|
|
await fs.writeFile(path.join(root, "pnpm-workspace.yaml"), "packages:\n - packages/*\n", "utf8");
|
|
await fs.writeFile(path.join(root, "package.json"), '{"name":"paperclip"}\n', "utf8");
|
|
await fs.writeFile(
|
|
path.join(root, "skills", skillName, "SKILL.md"),
|
|
`---\nname: ${skillName}\n---\n`,
|
|
"utf8",
|
|
);
|
|
}
|
|
|
|
async function createCustomSkill(root: string, skillName: string) {
|
|
await fs.mkdir(path.join(root, "custom", skillName), { recursive: true });
|
|
await fs.writeFile(
|
|
path.join(root, "custom", skillName, "SKILL.md"),
|
|
`---\nname: ${skillName}\n---\n`,
|
|
"utf8",
|
|
);
|
|
}
|
|
|
|
describe("codex local adapter skill injection", () => {
|
|
const paperclipKey = "paperclipai/paperclip/paperclip";
|
|
const createAgentKey = "paperclipai/paperclip/paperclip-create-agent";
|
|
const cleanupDirs = new Set<string>();
|
|
|
|
afterEach(async () => {
|
|
await Promise.all(Array.from(cleanupDirs).map((dir) => fs.rm(dir, { recursive: true, force: true })));
|
|
cleanupDirs.clear();
|
|
});
|
|
|
|
it("repairs a Codex Paperclip skill symlink that still points at another live checkout", async () => {
|
|
const currentRepo = await makeTempDir("paperclip-codex-current-");
|
|
const oldRepo = await makeTempDir("paperclip-codex-old-");
|
|
const skillsHome = await makeTempDir("paperclip-codex-home-");
|
|
cleanupDirs.add(currentRepo);
|
|
cleanupDirs.add(oldRepo);
|
|
cleanupDirs.add(skillsHome);
|
|
|
|
await createPaperclipRepoSkill(currentRepo, "paperclip");
|
|
await createPaperclipRepoSkill(currentRepo, "paperclip-create-agent");
|
|
await createPaperclipRepoSkill(oldRepo, "paperclip");
|
|
await fs.symlink(path.join(oldRepo, "skills", "paperclip"), path.join(skillsHome, "paperclip"));
|
|
|
|
const logs: Array<{ stream: "stdout" | "stderr"; chunk: string }> = [];
|
|
await ensureCodexSkillsInjected(
|
|
async (stream, chunk) => {
|
|
logs.push({ stream, chunk });
|
|
},
|
|
{
|
|
skillsHome,
|
|
skillsEntries: [
|
|
{
|
|
key: paperclipKey,
|
|
runtimeName: "paperclip",
|
|
source: path.join(currentRepo, "skills", "paperclip"),
|
|
},
|
|
{
|
|
key: createAgentKey,
|
|
runtimeName: "paperclip-create-agent",
|
|
source: path.join(currentRepo, "skills", "paperclip-create-agent"),
|
|
},
|
|
],
|
|
},
|
|
);
|
|
|
|
expect(await fs.realpath(path.join(skillsHome, "paperclip"))).toBe(
|
|
await fs.realpath(path.join(currentRepo, "skills", "paperclip")),
|
|
);
|
|
expect(await fs.realpath(path.join(skillsHome, "paperclip-create-agent"))).toBe(
|
|
await fs.realpath(path.join(currentRepo, "skills", "paperclip-create-agent")),
|
|
);
|
|
expect(logs).toContainEqual(
|
|
expect.objectContaining({
|
|
stream: "stdout",
|
|
chunk: expect.stringContaining('Repaired Codex skill "paperclip"'),
|
|
}),
|
|
);
|
|
expect(logs).toContainEqual(
|
|
expect.objectContaining({
|
|
stream: "stdout",
|
|
chunk: expect.stringContaining('Injected Codex skill "paperclip-create-agent"'),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("preserves a custom Codex skill symlink outside Paperclip repo checkouts", async () => {
|
|
const currentRepo = await makeTempDir("paperclip-codex-current-");
|
|
const customRoot = await makeTempDir("paperclip-codex-custom-");
|
|
const skillsHome = await makeTempDir("paperclip-codex-home-");
|
|
cleanupDirs.add(currentRepo);
|
|
cleanupDirs.add(customRoot);
|
|
cleanupDirs.add(skillsHome);
|
|
|
|
await createPaperclipRepoSkill(currentRepo, "paperclip");
|
|
await createCustomSkill(customRoot, "paperclip");
|
|
await fs.symlink(path.join(customRoot, "custom", "paperclip"), path.join(skillsHome, "paperclip"));
|
|
|
|
await ensureCodexSkillsInjected(async () => {}, {
|
|
skillsHome,
|
|
skillsEntries: [{
|
|
key: paperclipKey,
|
|
runtimeName: "paperclip",
|
|
source: path.join(currentRepo, "skills", "paperclip"),
|
|
}],
|
|
});
|
|
|
|
expect(await fs.realpath(path.join(skillsHome, "paperclip"))).toBe(
|
|
await fs.realpath(path.join(customRoot, "custom", "paperclip")),
|
|
);
|
|
});
|
|
|
|
it("prunes broken symlinks for unavailable Paperclip repo skills before Codex starts", async () => {
|
|
const currentRepo = await makeTempDir("paperclip-codex-current-");
|
|
const oldRepo = await makeTempDir("paperclip-codex-old-");
|
|
const skillsHome = await makeTempDir("paperclip-codex-home-");
|
|
cleanupDirs.add(currentRepo);
|
|
cleanupDirs.add(oldRepo);
|
|
cleanupDirs.add(skillsHome);
|
|
|
|
await createPaperclipRepoSkill(currentRepo, "paperclip");
|
|
await createPaperclipRepoSkill(oldRepo, "agent-browser");
|
|
const staleTarget = path.join(oldRepo, "skills", "agent-browser");
|
|
await fs.symlink(staleTarget, path.join(skillsHome, "agent-browser"));
|
|
await fs.rm(staleTarget, { recursive: true, force: true });
|
|
|
|
const logs: Array<{ stream: "stdout" | "stderr"; chunk: string }> = [];
|
|
await ensureCodexSkillsInjected(
|
|
async (stream, chunk) => {
|
|
logs.push({ stream, chunk });
|
|
},
|
|
{
|
|
skillsHome,
|
|
skillsEntries: [{
|
|
key: paperclipKey,
|
|
runtimeName: "paperclip",
|
|
source: path.join(currentRepo, "skills", "paperclip"),
|
|
}],
|
|
},
|
|
);
|
|
|
|
await expect(fs.lstat(path.join(skillsHome, "agent-browser"))).rejects.toMatchObject({
|
|
code: "ENOENT",
|
|
});
|
|
expect(logs).toContainEqual(
|
|
expect.objectContaining({
|
|
stream: "stdout",
|
|
chunk: expect.stringContaining('Removed stale Codex skill "agent-browser"'),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("preserves other live Paperclip skill symlinks in the shared workspace skill directory", async () => {
|
|
const currentRepo = await makeTempDir("paperclip-codex-current-");
|
|
const skillsHome = await makeTempDir("paperclip-codex-home-");
|
|
cleanupDirs.add(currentRepo);
|
|
cleanupDirs.add(skillsHome);
|
|
|
|
await createPaperclipRepoSkill(currentRepo, "paperclip");
|
|
await createPaperclipRepoSkill(currentRepo, "agent-browser");
|
|
await fs.symlink(
|
|
path.join(currentRepo, "skills", "agent-browser"),
|
|
path.join(skillsHome, "agent-browser"),
|
|
);
|
|
|
|
await ensureCodexSkillsInjected(async () => {}, {
|
|
skillsHome,
|
|
skillsEntries: [{
|
|
key: paperclipKey,
|
|
runtimeName: "paperclip",
|
|
source: path.join(currentRepo, "skills", "paperclip"),
|
|
}],
|
|
});
|
|
|
|
expect((await fs.lstat(path.join(skillsHome, "paperclip"))).isSymbolicLink()).toBe(true);
|
|
expect((await fs.lstat(path.join(skillsHome, "agent-browser"))).isSymbolicLink()).toBe(true);
|
|
expect(await fs.realpath(path.join(skillsHome, "agent-browser"))).toBe(
|
|
await fs.realpath(path.join(currentRepo, "skills", "agent-browser")),
|
|
);
|
|
});
|
|
});
|