mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 10:13:11 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Agents can select company skills and synchronize them to adapter runtimes > - The skill sync API replaced the complete selection without an explicit destructive choice > - Company package import also replaced conflicting skills by default > - These defaults could remove operator edits during setup and import reruns > - This pull request adds explicit assignment merge modes and safe package conflict handling > - The benefit is that reruns preserve operator work unless the caller explicitly requests replacement ## Linked Issues or Issue Description **What existing behavior does this improve?** This change improves agent skill synchronization and company package import. **Subsystem affected** This is a cross-cutting change across the shared contracts, server, CLI, and UI. **Current behavior** Agent skill synchronization replaces the full desired skill set from a modeless request. Package import replaces a conflicting skill when the caller does not select a conflict mode. **Proposed behavior** Agent skill synchronization requires `add`, `remove`, or `replace`. Package import skips conflicts by default. Each imported skill reports whether it was created, renamed, replaced, or skipped. **Reason and benefit** Setup and import reruns must preserve operator edits by default. Explicit destructive modes make data loss less likely and make each outcome inspectable. **Breaking changes** Callers of the agent skill sync API must now send `mode`. Callers that need the former behavior must send `replace`. Package import now uses `skip` when `onConflict` is absent. ## What Changed - Added required `add`, `remove`, and `replace` modes to the shared agent skill sync contract. - Added actionable `422` validation for missing or invalid modes. - Updated first-party UI and CLI callers with explicit modes. - Changed package skill conflict handling to use `skip` by default. - Kept plugin-owned and built-in stock skill imports on explicit `replace`. - Added created, renamed, replaced, and skipped results to company imports. - Added regression coverage for merge modes and package conflict outcomes. ## Verification - `pnpm check:token-gates` - `pnpm -r typecheck` - `pnpm build` - `pnpm test:run:serialized` (128 suites passed) - `pnpm --filter @paperclipai/skills-catalog test` (20 tests passed) - Focused agent skill route, company skill service, portability, CLI, and UI tests passed. - GitHub CI passed build, typecheck, canary, all general and serialized test shards, all browser shards, policy, security, and final verification on commit `2cfbb3e4c5`. - Greptile reviewed the latest commit at 5/5 with zero unresolved threads. ## Risks - This change intentionally rejects modeless agent skill sync requests. - The safe package default can leave an existing skill unchanged where the old default overwrote it. - All first-party callers now select a mode. Regression tests cover each outcome. > 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 `gpt-5.6-sol` through Codex. The runtime used agentic reasoning, tool use, code execution, and repository editing. The runtime did not expose the context window size. ## 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>
249 lines
9.6 KiB
TypeScript
249 lines
9.6 KiB
TypeScript
import type {
|
|
Agent,
|
|
AgentDesiredSkillEntry,
|
|
AgentSkillAssignmentMode,
|
|
AgentPermissions,
|
|
AgentDetail,
|
|
AgentInstructionsBundle,
|
|
AgentInstructionsFileDetail,
|
|
AgentSkillSnapshot,
|
|
AdapterEnvironmentTestResult,
|
|
AgentKeyCreated,
|
|
AgentRuntimeState,
|
|
AgentTaskSession,
|
|
AgentWakeupResponse,
|
|
HeartbeatRun,
|
|
Approval,
|
|
AgentConfigRevision,
|
|
ClearAgentErrorResponse,
|
|
AgentApiKeyScope,
|
|
} from "@paperclipai/shared";
|
|
import type {
|
|
AdapterModelProfileDefinition,
|
|
AdapterModelProfileKey,
|
|
} from "@paperclipai/adapter-utils";
|
|
import { isUuidLike, normalizeAgentUrlKey } from "@paperclipai/shared";
|
|
import { ApiError, api } from "./client";
|
|
|
|
export interface AgentKey {
|
|
id: string;
|
|
name: string;
|
|
scope: AgentApiKeyScope;
|
|
createdAt: Date;
|
|
revokedAt: Date | null;
|
|
}
|
|
|
|
export interface AdapterModel {
|
|
id: string;
|
|
label: string;
|
|
}
|
|
|
|
export type { AdapterModelProfileKey };
|
|
export type AdapterModelProfile = AdapterModelProfileDefinition;
|
|
|
|
export interface DetectedAdapterModel {
|
|
model: string;
|
|
provider: string;
|
|
source: string;
|
|
candidates?: string[];
|
|
}
|
|
|
|
export interface ClaudeLoginResult {
|
|
exitCode: number | null;
|
|
signal: string | null;
|
|
timedOut: boolean;
|
|
loginUrl: string | null;
|
|
stdout: string;
|
|
stderr: string;
|
|
}
|
|
|
|
export interface OrgNode {
|
|
id: string;
|
|
name: string;
|
|
role: string;
|
|
status: string;
|
|
reports: OrgNode[];
|
|
}
|
|
|
|
export interface AgentHireResponse {
|
|
agent: Agent;
|
|
approval: Approval | null;
|
|
}
|
|
|
|
export interface AgentPermissionUpdate {
|
|
canCreateAgents: boolean;
|
|
canCreateSkills: boolean;
|
|
canAssignTasks: boolean;
|
|
trustPreset?: AgentPermissions["trustPreset"];
|
|
authorizationPolicy?: AgentPermissions["authorizationPolicy"];
|
|
}
|
|
|
|
export interface AgentWakeRequest {
|
|
source?: "timer" | "assignment" | "on_demand" | "automation";
|
|
triggerDetail?: "manual" | "ping" | "callback" | "system";
|
|
reason?: string | null;
|
|
payload?: Record<string, unknown> | null;
|
|
idempotencyKey?: string | null;
|
|
forceFreshSession?: boolean;
|
|
}
|
|
|
|
function withCompanyScope(path: string, companyId?: string) {
|
|
if (!companyId) return path;
|
|
const separator = path.includes("?") ? "&" : "?";
|
|
return `${path}${separator}companyId=${encodeURIComponent(companyId)}`;
|
|
}
|
|
|
|
function agentPath(id: string, companyId?: string, suffix = "") {
|
|
return withCompanyScope(`/agents/${encodeURIComponent(id)}${suffix}`, companyId);
|
|
}
|
|
|
|
export const agentsApi = {
|
|
list: (companyId: string) => api.get<Agent[]>(`/companies/${companyId}/agents`),
|
|
org: (companyId: string) => api.get<OrgNode[]>(`/companies/${companyId}/org`),
|
|
listConfigurations: (companyId: string) =>
|
|
api.get<Record<string, unknown>[]>(`/companies/${companyId}/agent-configurations`),
|
|
get: async (id: string, companyId?: string) => {
|
|
try {
|
|
return await api.get<AgentDetail>(agentPath(id, companyId));
|
|
} catch (error) {
|
|
// Backward-compat fallback: if backend shortname lookup reports ambiguity,
|
|
// resolve using company agent list while ignoring terminated agents.
|
|
if (
|
|
!(error instanceof ApiError) ||
|
|
error.status !== 409 ||
|
|
!companyId ||
|
|
isUuidLike(id)
|
|
) {
|
|
throw error;
|
|
}
|
|
|
|
const urlKey = normalizeAgentUrlKey(id);
|
|
if (!urlKey) throw error;
|
|
|
|
const agents = await api.get<Agent[]>(`/companies/${companyId}/agents`);
|
|
const matches = agents.filter(
|
|
(agent) => agent.status !== "terminated" && normalizeAgentUrlKey(agent.urlKey) === urlKey,
|
|
);
|
|
if (matches.length !== 1) throw error;
|
|
return api.get<AgentDetail>(agentPath(matches[0]!.id, companyId));
|
|
}
|
|
},
|
|
getConfiguration: (id: string, companyId?: string) =>
|
|
api.get<Record<string, unknown>>(agentPath(id, companyId, "/configuration")),
|
|
listConfigRevisions: (id: string, companyId?: string) =>
|
|
api.get<AgentConfigRevision[]>(agentPath(id, companyId, "/config-revisions")),
|
|
getConfigRevision: (id: string, revisionId: string, companyId?: string) =>
|
|
api.get<AgentConfigRevision>(agentPath(id, companyId, `/config-revisions/${revisionId}`)),
|
|
rollbackConfigRevision: (id: string, revisionId: string, companyId?: string) =>
|
|
api.post<Agent>(agentPath(id, companyId, `/config-revisions/${revisionId}/rollback`), {}),
|
|
create: (companyId: string, data: Record<string, unknown>) =>
|
|
api.post<Agent>(`/companies/${companyId}/agents`, data),
|
|
hire: (companyId: string, data: Record<string, unknown>) =>
|
|
api.post<AgentHireResponse>(`/companies/${companyId}/agent-hires`, data),
|
|
update: (id: string, data: Record<string, unknown>, companyId?: string) =>
|
|
api.patch<Agent>(agentPath(id, companyId), data),
|
|
updatePermissions: (id: string, data: AgentPermissionUpdate, companyId?: string) =>
|
|
api.patch<AgentDetail>(agentPath(id, companyId, "/permissions"), data),
|
|
instructionsBundle: (id: string, companyId?: string) =>
|
|
api.get<AgentInstructionsBundle>(agentPath(id, companyId, "/instructions-bundle")),
|
|
updateInstructionsBundle: (
|
|
id: string,
|
|
data: {
|
|
mode?: "managed" | "external";
|
|
rootPath?: string | null;
|
|
entryFile?: string;
|
|
clearLegacyPromptTemplate?: boolean;
|
|
},
|
|
companyId?: string,
|
|
) => api.patch<AgentInstructionsBundle>(agentPath(id, companyId, "/instructions-bundle"), data),
|
|
instructionsFile: (id: string, relativePath: string, companyId?: string) =>
|
|
api.get<AgentInstructionsFileDetail>(
|
|
agentPath(id, companyId, `/instructions-bundle/file?path=${encodeURIComponent(relativePath)}`),
|
|
),
|
|
saveInstructionsFile: (
|
|
id: string,
|
|
data: { path: string; content: string; clearLegacyPromptTemplate?: boolean },
|
|
companyId?: string,
|
|
) => api.put<AgentInstructionsFileDetail>(agentPath(id, companyId, "/instructions-bundle/file"), data),
|
|
deleteInstructionsFile: (id: string, relativePath: string, companyId?: string) =>
|
|
api.delete<AgentInstructionsBundle>(
|
|
agentPath(id, companyId, `/instructions-bundle/file?path=${encodeURIComponent(relativePath)}`),
|
|
),
|
|
pause: (id: string, companyId?: string) => api.post<Agent>(agentPath(id, companyId, "/pause"), {}),
|
|
resume: (id: string, companyId?: string) => api.post<Agent>(agentPath(id, companyId, "/resume"), {}),
|
|
clearError: (id: string, companyId?: string) =>
|
|
api.post<ClearAgentErrorResponse>(agentPath(id, companyId, "/clear-error"), {}),
|
|
approve: (id: string, companyId?: string) => api.post<Agent>(agentPath(id, companyId, "/approve"), {}),
|
|
terminate: (id: string, companyId?: string) => api.post<Agent>(agentPath(id, companyId, "/terminate"), {}),
|
|
remove: (id: string, companyId?: string) => api.delete<{ ok: true }>(agentPath(id, companyId)),
|
|
listKeys: (id: string, companyId?: string) => api.get<AgentKey[]>(agentPath(id, companyId, "/keys")),
|
|
skills: (id: string, companyId?: string) =>
|
|
api.get<AgentSkillSnapshot>(agentPath(id, companyId, "/skills")),
|
|
syncSkills: (
|
|
id: string,
|
|
desiredSkills: Array<string | AgentDesiredSkillEntry>,
|
|
mode: AgentSkillAssignmentMode,
|
|
companyId?: string,
|
|
) => api.post<AgentSkillSnapshot>(agentPath(id, companyId, "/skills/sync"), { desiredSkills, mode }),
|
|
createKey: (id: string, name: string, companyId?: string, scope?: AgentApiKeyScope) =>
|
|
api.post<AgentKeyCreated>(agentPath(id, companyId, "/keys"), { name, ...(scope ? { scope } : {}) }),
|
|
revokeKey: (agentId: string, keyId: string, companyId?: string) =>
|
|
api.delete<{ ok: true }>(agentPath(agentId, companyId, `/keys/${encodeURIComponent(keyId)}`)),
|
|
runtimeState: (id: string, companyId?: string) =>
|
|
api.get<AgentRuntimeState>(agentPath(id, companyId, "/runtime-state")),
|
|
taskSessions: (id: string, companyId?: string) =>
|
|
api.get<AgentTaskSession[]>(agentPath(id, companyId, "/task-sessions")),
|
|
resetSession: (id: string, taskKey?: string | null, companyId?: string) =>
|
|
api.post<void>(agentPath(id, companyId, "/runtime-state/reset-session"), { taskKey: taskKey ?? null }),
|
|
adapterModels: (
|
|
companyId: string,
|
|
type: string,
|
|
options?: { refresh?: boolean; environmentId?: string | null },
|
|
) => {
|
|
const params = new URLSearchParams();
|
|
if (options?.refresh) params.set("refresh", "1");
|
|
if (options?.environmentId) params.set("environmentId", options.environmentId);
|
|
const query = params.size > 0 ? `?${params.toString()}` : "";
|
|
return api.get<AdapterModel[]>(
|
|
`/companies/${encodeURIComponent(companyId)}/adapters/${encodeURIComponent(type)}/models${query}`,
|
|
);
|
|
},
|
|
detectModel: (companyId: string, type: string) =>
|
|
api.get<DetectedAdapterModel | null>(
|
|
`/companies/${encodeURIComponent(companyId)}/adapters/${encodeURIComponent(type)}/detect-model`,
|
|
),
|
|
adapterModelProfiles: (companyId: string, type: string) =>
|
|
api.get<AdapterModelProfile[]>(
|
|
`/companies/${encodeURIComponent(companyId)}/adapters/${encodeURIComponent(type)}/model-profiles`,
|
|
),
|
|
testEnvironment: (
|
|
companyId: string,
|
|
type: string,
|
|
data: {
|
|
adapterConfig: Record<string, unknown>;
|
|
environmentId?: string | null;
|
|
},
|
|
) =>
|
|
api.post<AdapterEnvironmentTestResult>(
|
|
`/companies/${companyId}/adapters/${type}/test-environment`,
|
|
data,
|
|
),
|
|
invoke: (id: string, companyId?: string, data: AgentWakeRequest = {}) =>
|
|
api.post<HeartbeatRun>(agentPath(id, companyId, "/heartbeat/invoke"), data),
|
|
wakeup: (
|
|
id: string,
|
|
data: AgentWakeRequest,
|
|
companyId?: string,
|
|
) => api.post<AgentWakeupResponse>(agentPath(id, companyId, "/wakeup"), data),
|
|
loginWithClaude: (id: string, companyId?: string) =>
|
|
api.post<ClaudeLoginResult>(agentPath(id, companyId, "/claude-login"), {}),
|
|
availableSkills: () =>
|
|
api.get<{ skills: AvailableSkill[] }>("/skills/available"),
|
|
};
|
|
|
|
export interface AvailableSkill {
|
|
name: string;
|
|
description: string;
|
|
isPaperclipManaged: boolean;
|
|
}
|