mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-15 12:28:10 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Operators need first-party agent capabilities for repeatable company work, not just manually created one-off agents. > - Built-in agents need to behave like normal company-scoped agents while preserving approval gates, permissions, budgets, and audit trails. > - Reflection and coaching work also needs bundled instructions, skill content, and a routine so the feature can be installed and reset predictably. > - The API, database, UI, portability, and tests all need to agree on the built-in lifecycle from not provisioned through setup, approval, ready, paused, and reset. > - This pull request adds built-in agent provisioning and the Reflection Coach bundle end-to-end. > - The benefit is a safer first-party path for Paperclip-managed agents without bypassing the same governance model used for operator-created agents. ## Linked Issues or Issue Description No public GitHub issue was found for this exact built-in agent and Reflection Coach bundle work. Problem/motivation: - Paperclip did not have a first-party built-in agent lifecycle for product-owned agents. - Bundled agent resources such as default instructions, skills, and routines needed managed ownership and reset semantics. - Approval-gated companies needed built-in setup to preserve requested adapter, budget, manager, and permission state through board approval. - The board UI needed clear built-in badges, setup affordances, readiness state, and bundle status without exposing secrets. Proposed solution: - Add a company-scoped built-in agent registry, provisioning/reset/reconcile/status APIs, and Reflection Coach bundled resources. - Track bundled managed resources in the database with idempotent migration behavior. - Reuse existing agent approval, authorization, budget, and activity-log paths instead of creating a bypass. - Add UI setup, badges, gates, bundle panels, and route coverage for built-in agents. Duplicate search: - Searched GitHub PRs for `built-in agents Reflection Coach repo:paperclipai/paperclip`; only this PR was returned. - Searched GitHub issues for the same query; no public issues were returned. ## What Changed - Added built-in agent definitions, lifecycle state derivation, provisioning, reset, reconcile, status, and routine-control routes. - Added the `built_in_managed_resources` migration and schema exports for bundled instructions, skill, and routine ownership. - Added the Reflection Coach built-in bundle with default instructions, skill catalog content, routine template, default permissions, and managed-resource drift handling. - Added approval-aware provisioning behavior that preserves requested adapter config, budgets, manager assignment, and built-in permissions through hire approval. - Added authorization and mutation gates for built-in agent and skill changes, including consented Reflection Coach change paths. - Added UI surfaces for built-in agent setup, roster/detail badges, readiness gates, bundle status, routine controls, and route filtering. - Added company import/export and validator coverage for built-in managed resources and low-trust/red-team presets. - Addressed Greptile follow-ups for pending approval reconciliation, consent-gate error propagation, config-read authorization fallback, approval-path manager preservation, and non-model adapter provisioning. ## Verification Local verification: - `git diff --check public/master..HEAD` passed. - `pnpm check:token-gates` passed with all gates clean. - `pnpm exec vitest run ui/src/components/ConfigureBuiltInAgentModal.test.tsx` passed: 1 file, 4 tests. - `pnpm exec vitest run ui/src/components/EntityRow.test.tsx ui/src/pages/Agents.test.tsx ui/src/components/BuiltInAgentGate.test.tsx ui/src/components/ConfigureBuiltInAgentModal.test.tsx ui/src/components/BuiltInBundlePanel.test.tsx ui/src/pages/InstanceExperimentalSettings.test.tsx ui/src/pages/Routines.test.tsx` passed: 7 files, 64 tests. - `pnpm --filter @paperclipai/server exec vitest run src/__tests__/built-in-agents.test.ts src/__tests__/authorization-service.test.ts src/__tests__/company-skills-routes.test.ts` passed: 3 files, 91 tests. - `pnpm --filter @paperclipai/db check:migrations` passed. - `pnpm -r typecheck` passed after the rebase; `pnpm --filter ui typecheck` passed after the final UI review fix. Remote verification on latest head `1c61f693a4ec881d739022b0e75a8ca8bf8c2cd8`: - Merge state: `CLEAN`. - Greptile: `5/5`, zero unresolved Greptile threads. - PR check rollup: all checks successful, neutral, or skipped as expected. - Passing gates include Build, Typecheck + Release Registry, all server shards, all workspace shards, all serialized server suites, e2e, Canary Dry Run, policy, review, verify, Socket, Superagent, and Snyk. ## Risks - This adds a new managed-resource table and migration; the migration uses idempotent create/add/index guards and passed migration safety checks. - Built-in agent provisioning touches approval and authorization paths; tests cover pending approval preservation, stale retry rejection, consent gates, and config-read fallback behavior. - Reflection Coach creates managed instructions, skill, and routine resources; drift/reset behavior is covered by service tests and redacted API responses. - Non-model adapter setup now provisions a `needs_setup` built-in row before command/endpoint fields are complete; this matches the server lifecycle and is covered by the setup modal regression test. ## Model Used OpenAI Codex coding agent based on GPT-5. Exact hosted model ID, context-window size, and reasoning-mode labels are not exposed in this runtime; tool use, shell execution, GitHub CLI/API access, and local code editing were enabled. ## 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>
436 lines
15 KiB
TypeScript
436 lines
15 KiB
TypeScript
import type { ReactNode } from "react";
|
||
|
||
import { Link } from "@/lib/router";
|
||
import { Button } from "@/components/ui/button";
|
||
import {
|
||
AlertDialog,
|
||
AlertDialogAction,
|
||
AlertDialogCancel,
|
||
AlertDialogContent,
|
||
AlertDialogDescription,
|
||
AlertDialogFooter,
|
||
AlertDialogHeader,
|
||
AlertDialogTitle,
|
||
AlertDialogTrigger,
|
||
} from "@/components/ui/alert-dialog";
|
||
import { ResourceStatusChip, type ResourceStatusVariant } from "@/components/ResourceStatusChip";
|
||
import { cn } from "@/lib/utils";
|
||
import type {
|
||
BuiltInAgentState,
|
||
BuiltInManagedResourceKind,
|
||
BuiltInManagedResourceState,
|
||
} from "@/api/builtInAgents";
|
||
|
||
/**
|
||
* Bundle status panel for a bundle-backed built-in agent (Reflection Coach —
|
||
* [PAP-13099], ux-spec §3–§8). Renders one row per managed resource
|
||
* (adapter · skill · instructions · routine, dependency order) with a readiness
|
||
* chip, drift chip, inline copy, and the wireable per-resource actions.
|
||
*
|
||
* Presentational: the parent owns queries/mutations and passes handlers. The
|
||
* confirm-before-mutate dialogs and copy live here (ux-spec §8). Adapter
|
||
* readiness is derived from the agent lifecycle `status` (there is no adapter
|
||
* resource in `resources[]`); skill/instructions/routine come from
|
||
* `state.resources`.
|
||
*
|
||
* Both "apply an available stock update" and "reset drifted edits" route
|
||
* through the same scoped reset (`onResetResource(kind)` →
|
||
* `built-in-agents/:key/reset { resources: [kind] }`), which re-materializes
|
||
* that one resource to Paperclip's newest shipped default without touching
|
||
* adapter credentials or the other resources.
|
||
*/
|
||
|
||
function findResource(
|
||
resources: BuiltInManagedResourceState[] | undefined,
|
||
kind: BuiltInManagedResourceKind,
|
||
): BuiltInManagedResourceState | undefined {
|
||
return resources?.find((resource) => resource.resourceKind === kind);
|
||
}
|
||
|
||
/** Readiness chip for a materialized resource. */
|
||
function readinessVariant(resource: BuiltInManagedResourceState): ResourceStatusVariant {
|
||
if (resource.stockStatus === "missing") return "missing";
|
||
return "ready";
|
||
}
|
||
|
||
/** Drift chip shown alongside a `ready` readiness chip, or `null`. */
|
||
function driftVariant(resource: BuiltInManagedResourceState): ResourceStatusVariant | null {
|
||
if (resource.stockStatus === "missing") return null; // readiness wins; drift suppressed
|
||
if (resource.stockStatus === "stock_update_available") return "update_available";
|
||
if (resource.stockStatus === "operator_modified") return "drifted";
|
||
return null;
|
||
}
|
||
|
||
interface ResourceActionCopy {
|
||
title: string;
|
||
body: string;
|
||
confirmLabel: string;
|
||
triggerLabel: string;
|
||
}
|
||
|
||
/** Confirm-dialog copy per drift state (ux-spec §8 copy deck). */
|
||
function resourceActionCopy(
|
||
resource: BuiltInManagedResourceState,
|
||
label: string,
|
||
): ResourceActionCopy | null {
|
||
if (resource.stockStatus === "stock_update_available") {
|
||
return {
|
||
title: `Update ${label} to the newest default?`,
|
||
body: `You haven't edited this, so Paperclip will replace it with the newer shipped version. Nothing you customized is affected, and your adapter credentials and settings are not touched.`,
|
||
confirmLabel: "Update",
|
||
triggerLabel: "Update",
|
||
};
|
||
}
|
||
if (resource.stockStatus === "operator_modified") {
|
||
return {
|
||
title: `Reset ${label} to the shipped default?`,
|
||
body: `This replaces your edited version with Paperclip's current default. Your edits can't be recovered. Adapter credentials and settings are not touched.`,
|
||
confirmLabel: `Reset ${label}`,
|
||
triggerLabel: "Reset",
|
||
};
|
||
}
|
||
if (resource.stockStatus === "missing") {
|
||
return {
|
||
title: `Recreate ${label}?`,
|
||
body: `This resource is missing. Paperclip will recreate it from the shipped default. Adapter credentials and settings are not touched.`,
|
||
confirmLabel: "Recreate",
|
||
triggerLabel: "Recreate",
|
||
};
|
||
}
|
||
return null;
|
||
}
|
||
|
||
function ResourceActionButton({
|
||
resource,
|
||
label,
|
||
onConfirm,
|
||
pending,
|
||
}: {
|
||
resource: BuiltInManagedResourceState;
|
||
label: string;
|
||
onConfirm: () => void;
|
||
pending: boolean;
|
||
}) {
|
||
const copy = resourceActionCopy(resource, label);
|
||
if (!copy) return null;
|
||
return (
|
||
<AlertDialog>
|
||
<AlertDialogTrigger asChild>
|
||
<Button variant="outline" size="sm" disabled={pending}>
|
||
{pending ? "Working…" : copy.triggerLabel}
|
||
</Button>
|
||
</AlertDialogTrigger>
|
||
<AlertDialogContent>
|
||
<AlertDialogHeader>
|
||
<AlertDialogTitle>{copy.title}</AlertDialogTitle>
|
||
<AlertDialogDescription>{copy.body}</AlertDialogDescription>
|
||
</AlertDialogHeader>
|
||
<AlertDialogFooter>
|
||
<AlertDialogCancel>Cancel</AlertDialogCancel>
|
||
<AlertDialogAction onClick={onConfirm}>{copy.confirmLabel}</AlertDialogAction>
|
||
</AlertDialogFooter>
|
||
</AlertDialogContent>
|
||
</AlertDialog>
|
||
);
|
||
}
|
||
|
||
function ConfirmActionButton({
|
||
title,
|
||
body,
|
||
triggerLabel,
|
||
confirmLabel,
|
||
pending,
|
||
onConfirm,
|
||
}: {
|
||
title: string;
|
||
body: string;
|
||
triggerLabel: string;
|
||
confirmLabel: string;
|
||
pending: boolean;
|
||
onConfirm: () => void;
|
||
}) {
|
||
return (
|
||
<AlertDialog>
|
||
<AlertDialogTrigger asChild>
|
||
<Button variant="outline" size="sm" disabled={pending}>
|
||
{pending ? "Working…" : triggerLabel}
|
||
</Button>
|
||
</AlertDialogTrigger>
|
||
<AlertDialogContent>
|
||
<AlertDialogHeader>
|
||
<AlertDialogTitle>{title}</AlertDialogTitle>
|
||
<AlertDialogDescription>{body}</AlertDialogDescription>
|
||
</AlertDialogHeader>
|
||
<AlertDialogFooter>
|
||
<AlertDialogCancel>Cancel</AlertDialogCancel>
|
||
<AlertDialogAction onClick={onConfirm}>{confirmLabel}</AlertDialogAction>
|
||
</AlertDialogFooter>
|
||
</AlertDialogContent>
|
||
</AlertDialog>
|
||
);
|
||
}
|
||
|
||
interface BundleRowProps {
|
||
label: string;
|
||
secondary?: string;
|
||
chips: ReactNode;
|
||
detail?: ReactNode;
|
||
detailTone?: "muted" | "error";
|
||
actions?: ReactNode;
|
||
}
|
||
|
||
function BundleRow({ label, secondary, chips, detail, detailTone = "muted", actions }: BundleRowProps) {
|
||
return (
|
||
<div className="flex flex-col gap-1 py-3 sm:flex-row sm:items-start sm:justify-between sm:gap-3">
|
||
<div className="min-w-0 space-y-1">
|
||
<div className="flex flex-wrap items-center gap-2">
|
||
<span className="text-sm font-medium">{label}</span>
|
||
{secondary && (
|
||
<span className="text-(length:--text-micro) text-muted-foreground">{secondary}</span>
|
||
)}
|
||
{chips}
|
||
</div>
|
||
{detail && (
|
||
<p
|
||
className={cn(
|
||
"text-(length:--text-micro) leading-snug",
|
||
detailTone === "error" ? "text-red-600 dark:text-red-400" : "text-muted-foreground",
|
||
)}
|
||
>
|
||
{detail}
|
||
</p>
|
||
)}
|
||
</div>
|
||
{actions && <div className="flex shrink-0 flex-wrap items-center gap-2">{actions}</div>}
|
||
</div>
|
||
);
|
||
}
|
||
|
||
function driftDetail(resource: BuiltInManagedResourceState): string | undefined {
|
||
switch (resource.stockStatus) {
|
||
case "operator_modified":
|
||
return "You've edited this. Your changes are kept until you reset.";
|
||
case "stock_update_available":
|
||
return "Paperclip shipped a newer default.";
|
||
case "missing":
|
||
return "Not materialized yet — recreate it from the shipped default.";
|
||
default:
|
||
return undefined;
|
||
}
|
||
}
|
||
|
||
export interface BuiltInBundlePanelProps {
|
||
state: BuiltInAgentState;
|
||
/** Route ref used to link View › actions to the agent's tabs. */
|
||
agentRef: string;
|
||
/** Opens the adapter configure modal. */
|
||
onConfigure: () => void;
|
||
/** Scoped reset for one resource (apply update / reset drift / recreate). */
|
||
onResetResource: (kind: BuiltInManagedResourceKind) => void;
|
||
/** Trigger the managed routine once without enabling its weekly schedule. */
|
||
onRunRoutine?: (routineKey: string) => void;
|
||
/** Enable the managed routine's weekly schedule. */
|
||
onEnableSchedule?: (routineKey: string) => void;
|
||
/** Disable the managed routine's weekly schedule. */
|
||
onDisableSchedule?: (routineKey: string) => void;
|
||
/** The resource kind whose reset is currently in flight, if any. */
|
||
resettingResource?: BuiltInManagedResourceKind | null;
|
||
routineActionPending?: "run" | "enable" | "disable" | null;
|
||
className?: string;
|
||
}
|
||
|
||
export function BuiltInBundlePanel({
|
||
state,
|
||
agentRef,
|
||
onConfigure,
|
||
onResetResource,
|
||
onRunRoutine,
|
||
onEnableSchedule,
|
||
onDisableSchedule,
|
||
resettingResource = null,
|
||
routineActionPending = null,
|
||
className,
|
||
}: BuiltInBundlePanelProps) {
|
||
const { status, definition, resources } = state;
|
||
const bundle = definition.bundle;
|
||
if (!bundle) return null;
|
||
|
||
const adapterReady = status === "ready" || status === "paused";
|
||
|
||
// --- Adapter row (derived from the agent lifecycle status) -----------------
|
||
let adapterChip: ResourceStatusVariant = "ready";
|
||
let adapterDetail: string | undefined;
|
||
if (status === "pending_approval") {
|
||
adapterChip = "pending_approval";
|
||
adapterDetail = "Waiting on board hire approval before this coach can run.";
|
||
} else if (!adapterReady) {
|
||
adapterChip = "needs_setup";
|
||
adapterDetail = "Pick an adapter this coach can run on.";
|
||
}
|
||
|
||
const skill = findResource(resources, "skill");
|
||
const instructions = findResource(resources, "instructions");
|
||
const routine = findResource(resources, "routine");
|
||
const scheduleEnabled = routine?.scheduleEnabled === true;
|
||
const routineKey = bundle.routine.routineKey;
|
||
const scheduleLabel = bundle.routine.scheduleLabel ?? "Weekly schedule";
|
||
const proposalIssueRef = routine?.pendingUpdateIssueIdentifier ?? routine?.pendingUpdateIssueId ?? null;
|
||
const proposalHref = proposalIssueRef && routine?.pendingUpdateInteractionId
|
||
? `/issues/${proposalIssueRef}#interaction-${routine.pendingUpdateInteractionId}`
|
||
: null;
|
||
|
||
const renderResourceRow = (
|
||
kind: BuiltInManagedResourceKind,
|
||
label: string,
|
||
secondary: string,
|
||
viewHref: string,
|
||
resource: BuiltInManagedResourceState,
|
||
) => {
|
||
const drift = driftVariant(resource);
|
||
return (
|
||
<BundleRow
|
||
key={kind}
|
||
label={label}
|
||
secondary={secondary}
|
||
chips={
|
||
<>
|
||
<ResourceStatusChip variant={readinessVariant(resource)} />
|
||
{drift && <ResourceStatusChip variant={drift} />}
|
||
</>
|
||
}
|
||
detail={driftDetail(resource)}
|
||
actions={
|
||
<>
|
||
<Button asChild variant="link" size="sm">
|
||
<Link to={viewHref}>View</Link>
|
||
</Button>
|
||
<ResourceActionButton
|
||
resource={resource}
|
||
label={label}
|
||
onConfirm={() => onResetResource(kind)}
|
||
pending={resettingResource === kind}
|
||
/>
|
||
</>
|
||
}
|
||
/>
|
||
);
|
||
};
|
||
|
||
return (
|
||
<section className={cn("space-y-2", className)} aria-label="Bundle status">
|
||
<h3 className="text-sm font-medium">Bundle status</h3>
|
||
|
||
<div className="divide-y rounded-lg border px-4">
|
||
{/* Adapter — no resource entry; readiness is the agent lifecycle. */}
|
||
<BundleRow
|
||
label="Adapter"
|
||
chips={<ResourceStatusChip variant={adapterChip} />}
|
||
detail={adapterDetail}
|
||
actions={
|
||
<Button variant="outline" size="sm" onClick={onConfigure}>
|
||
Configure
|
||
</Button>
|
||
}
|
||
/>
|
||
|
||
{skill &&
|
||
renderResourceRow(
|
||
"skill",
|
||
"Skill",
|
||
bundle.skill.displayName || skill.resourceKey,
|
||
`/agents/${agentRef}/skills`,
|
||
skill,
|
||
)}
|
||
|
||
{instructions &&
|
||
renderResourceRow(
|
||
"instructions",
|
||
"Instructions",
|
||
bundle.instructions.entryFile,
|
||
`/agents/${agentRef}/instructions`,
|
||
instructions,
|
||
)}
|
||
|
||
{/* Routine — zero-token-by-default; the weekly schedule ships off. */}
|
||
<BundleRow
|
||
label="Routine"
|
||
secondary={bundle.routine.title}
|
||
chips={
|
||
<>
|
||
<ResourceStatusChip
|
||
variant={scheduleEnabled ? "schedule_on" : "schedule_off"}
|
||
label={scheduleEnabled ? scheduleLabel : undefined}
|
||
/>
|
||
{routine && driftVariant(routine) && (
|
||
<ResourceStatusChip variant={driftVariant(routine)!} />
|
||
)}
|
||
</>
|
||
}
|
||
detail={
|
||
scheduleEnabled
|
||
? "The weekly schedule is enabled and can create background work."
|
||
: "Nothing runs until you enable the weekly schedule — it costs zero tokens by default."
|
||
}
|
||
actions={
|
||
routine ? (
|
||
<>
|
||
{onRunRoutine && (
|
||
<ConfirmActionButton
|
||
title="Run Reflection Coach once?"
|
||
body="Paperclip will create one routine task now. This does not enable the weekly schedule or turn on background work."
|
||
triggerLabel="Run once"
|
||
confirmLabel="Run once"
|
||
pending={routineActionPending === "run"}
|
||
onConfirm={() => onRunRoutine(routineKey)}
|
||
/>
|
||
)}
|
||
{scheduleEnabled
|
||
? onDisableSchedule && (
|
||
<ConfirmActionButton
|
||
title="Disable the weekly schedule?"
|
||
body="Paperclip will stop future scheduled Reflection Coach runs. Manual Run once remains available."
|
||
triggerLabel="Disable schedule"
|
||
confirmLabel="Disable schedule"
|
||
pending={routineActionPending === "disable"}
|
||
onConfirm={() => onDisableSchedule(routineKey)}
|
||
/>
|
||
)
|
||
: onEnableSchedule && (
|
||
<ConfirmActionButton
|
||
title="Enable the weekly schedule?"
|
||
body="Paperclip will allow Reflection Coach to create routine tasks on the weekly schedule. It can spend tokens when those tasks run."
|
||
triggerLabel="Enable weekly"
|
||
confirmLabel="Enable weekly"
|
||
pending={routineActionPending === "enable"}
|
||
onConfirm={() => onEnableSchedule(routineKey)}
|
||
/>
|
||
)}
|
||
{driftVariant(routine) && (
|
||
<ResourceActionButton
|
||
resource={routine}
|
||
label="routine"
|
||
onConfirm={() => onResetResource("routine")}
|
||
pending={resettingResource === "routine"}
|
||
/>
|
||
)}
|
||
</>
|
||
) : undefined
|
||
}
|
||
/>
|
||
{proposalHref && (
|
||
<BundleRow
|
||
label="Proposal"
|
||
chips={<ResourceStatusChip variant="proposal_pending" />}
|
||
detail="A proposed Reflection Coach update is waiting for review."
|
||
actions={
|
||
<Button asChild variant="link" size="sm">
|
||
<Link to={proposalHref}>Review proposal</Link>
|
||
</Button>
|
||
}
|
||
/>
|
||
)}
|
||
</div>
|
||
</section>
|
||
);
|
||
}
|