mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 02:44:50 +01: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>
126 lines
4.5 KiB
TypeScript
126 lines
4.5 KiB
TypeScript
import { useState, type ReactNode } from "react";
|
|
import { Link } from "react-router-dom";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import { Bot, Clock3 } from "lucide-react";
|
|
|
|
import { EmptyState } from "@/components/EmptyState";
|
|
import { InlineBanner } from "@/components/InlineBanner";
|
|
import { PageSkeleton } from "@/components/PageSkeleton";
|
|
import { Button } from "@/components/ui/button";
|
|
import { ConfigureBuiltInAgentModal } from "@/components/ConfigureBuiltInAgentModal";
|
|
import { builtInAgentsApi, type BuiltInAgentState } from "@/api/builtInAgents";
|
|
import { agentsApi } from "@/api/agents";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { agentUrl } from "@/lib/utils";
|
|
import { relativeTime } from "@/lib/utils";
|
|
|
|
export interface BuiltInAgentGateProps {
|
|
/** Registry key of the built-in agent that powers this feature (e.g. "briefs"). */
|
|
agentKey: string;
|
|
companyId: string | null | undefined;
|
|
/** Human label for the gated feature. Defaults to the agent's display name. */
|
|
featureLabel?: string;
|
|
children: ReactNode;
|
|
}
|
|
|
|
/**
|
|
* Wraps a feature surface that depends on a built-in agent and renders the
|
|
* right lifecycle state (ux-spec §4):
|
|
*
|
|
* - loading → skeleton
|
|
* - not_provisioned / needs_setup → setup empty-state + configure modal CTA
|
|
* - paused → amber banner + Resume over the (stale) children
|
|
* - ready → children
|
|
*/
|
|
export function BuiltInAgentGate({ agentKey, companyId, featureLabel, children }: BuiltInAgentGateProps) {
|
|
const queryClient = useQueryClient();
|
|
const [configureOpen, setConfigureOpen] = useState(false);
|
|
|
|
const { data: states, isLoading } = useQuery({
|
|
queryKey: queryKeys.builtInAgents.list(companyId ?? "__none__"),
|
|
queryFn: () => builtInAgentsApi.list(companyId!),
|
|
enabled: Boolean(companyId),
|
|
});
|
|
|
|
const state: BuiltInAgentState | undefined = states?.find((entry) => entry.definition.key === agentKey);
|
|
|
|
const resume = useMutation({
|
|
mutationFn: (agentId: string) => agentsApi.resume(agentId, companyId ?? undefined),
|
|
onSuccess: () => {
|
|
queryClient.invalidateQueries({ queryKey: queryKeys.builtInAgents.list(companyId ?? "__none__") });
|
|
if (companyId) queryClient.invalidateQueries({ queryKey: queryKeys.agents.list(companyId) });
|
|
},
|
|
});
|
|
|
|
// Unknown key or still resolving the company — fail open to the feature.
|
|
if (!companyId) return <>{children}</>;
|
|
if (isLoading && !states) return <PageSkeleton variant="detail" />;
|
|
if (!state) return <>{children}</>;
|
|
|
|
const label = featureLabel ?? state.definition.displayName;
|
|
|
|
if (state.status === "not_provisioned" || state.status === "needs_setup") {
|
|
return (
|
|
<>
|
|
<EmptyState
|
|
icon={Bot}
|
|
title={`Set up the ${state.definition.displayName}`}
|
|
message={`${label} is generated by a built-in agent. Configure its model to enable the feature.`}
|
|
action={`Set up ${state.definition.displayName}`}
|
|
onAction={() => setConfigureOpen(true)}
|
|
hideActionIcon
|
|
/>
|
|
<ConfigureBuiltInAgentModal
|
|
companyId={companyId}
|
|
state={state}
|
|
open={configureOpen}
|
|
onOpenChange={setConfigureOpen}
|
|
/>
|
|
</>
|
|
);
|
|
}
|
|
|
|
if (state.status === "pending_approval") {
|
|
return (
|
|
<EmptyState
|
|
icon={Clock3}
|
|
title={`${state.definition.displayName} is pending approval`}
|
|
message={`${label} will be available after the board approves this built-in agent hire.`}
|
|
/>
|
|
);
|
|
}
|
|
|
|
if (state.status === "paused" && state.agent) {
|
|
const pausedAt = state.agent.pausedAt ? relativeTime(state.agent.pausedAt) : null;
|
|
return (
|
|
<div className="space-y-4">
|
|
<InlineBanner
|
|
tone="warning"
|
|
title={`${label} is paused.`}
|
|
actions={
|
|
<>
|
|
<Button variant="ghost" size="sm" asChild>
|
|
<Link to={agentUrl(state.agent)}>View agent</Link>
|
|
</Button>
|
|
<Button
|
|
size="sm"
|
|
onClick={() => state.agent && resume.mutate(state.agent.id)}
|
|
disabled={resume.isPending}
|
|
>
|
|
{resume.isPending ? "Resuming…" : "Resume agent"}
|
|
</Button>
|
|
</>
|
|
}
|
|
>
|
|
Its built-in agent was paused{pausedAt ? ` ${pausedAt}` : ""}, so new{" "}
|
|
{label.toLowerCase()} isn't being generated.
|
|
</InlineBanner>
|
|
{/* Paused ≠ hidden: keep existing content readable, marked stale. */}
|
|
<div className="opacity-70">{children}</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
return <>{children}</>;
|
|
}
|