mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-12 06:10:44 +01:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - The board controls which agents can hire, with the "Can create
agents" permission on each agent
> - A CEO agent with that permission turned off could still hire,
because the CEO role allowed hiring before the server read the saved
permission
> - In chat, a CEO agent asked to hire then created the agent through
the `hire_agent` tool, against the board's policy
> - This pull request makes the saved permission decide, and uses the
CEO role only for old rows that never saved a value
> - It also tells a denied agent that the denial is final and where a
person can act
> - The benefit is that the permissions page and the server now agree,
and the board can trust a hiring denial
## Linked Issues or Issue Description
**What happened**
A board user turned off "Can create agents" for a CEO agent. Then the
user asked the CEO in chat to hire a QA engineer. The CEO called
`hire_agent` (`POST /api/companies/{companyId}/agent-hires`). The server
returned 201 and created the agent. The legacy creator rule allowed any
agent with `role: "ceo"` before it read `permissions.canCreateAgents`.
**Expected behavior**
An explicit `canCreateAgents: false` denies hiring for every role,
including CEO. The agent gets a 403 that says the denial is final, and
it sends the person to the hire form or to its permissions page.
**Steps to reproduce**
1. Create a company with a CEO agent.
2. On the CEO's permissions page, turn off "Can create agents".
3. In chat with the CEO, send "Hire a QA engineer named Morgan."
4. See that a new agent named Morgan exists.
Found by the chat eval case `agents.hire-denied`. Related: #19614 (chat
eval harness).
## What Changed
- `canCreateAgentsLegacy` (authorization) uses the role-aware permission
normalization. A CEO keeps hiring unless the board recorded a hiring
denial.
- New `ceoHiringDeniedBy` record in `permissions` (`{ actorType,
actorId, at }`). `PATCH /agents/:id/permissions` writes it when an
authorized actor saves a CEO's hiring as off (an earlier record is
kept). The page shows the effective value, so a saved off is the board's
choice. Turning the toggle off also removes an explicit `agents:create`
grant. A saved `canCreateAgents: false` restricts a CEO only together
with this record.
- Reads report the effective value. A CEO row with no value, or with an
unrecorded false, shows hiring on. A CEO with a recorded denial shows it
off.
- Create and hire inputs cannot supply the record. Configuration updates
keep an existing record unless they turn hiring on. Company export keeps
a CEO's recorded denial, and import restores it, stamped by the
importing user.
- `PATCH /agents/:id/permissions`: an agent actor needs `agents:create`
to change `canCreateAgents`. A denied CEO cannot restore hiring for
itself or grant it to another agent.
- `assertCanCreateAgentsForCompany` adds a final, actionable sentence to
an agent's `agents:create` denial on hiring routes only (`POST /agents`,
`POST /agent-hires`, the hiring toggle on `PATCH /permissions`).
- `POST /api/companies/:companyId/imports/apply` (CEO-safe import): an
agent import that would create agents needs an `agents:create` decision
before any write. Before, any CEO agent could create agents this way.
Import also removes an existing `agents:create` grant when it restores a
CEO's denial.
- Chat guidance tells the agent to link `/<prefix>/agents/new` and its
own `/permissions` page when it cannot hire.
- Regression tests: authorization (a recorded denial is honored; an
unrecorded false keeps CEO hiring), normalization, route tests (denial
text, self-escalation, the record is written only when a CEO is turned
off), service tests for the permission and configuration write paths,
chat guidance text.
### Why a recorded denial and not a plain false
These normal paths save `canCreateAgents: false` on a CEO without a
board choice:
- The permissions page posts the full object. Before this change, a
legacy CEO row with `{}` was read as false, so saving any other toggle
stored false.
- A company import that updates an existing agent normalizes the
manifest permissions in the "stored" context. A manifest without the
field stores false. Export drops false values, so this is common.
- Low-trust creation stores false. If the trust preset later changes to
standard, the false remains.
These paths store true or nothing for a CEO: onboarding seed
(`requestHire`, create context: true), teams-catalog and import creation
(create context: true; the bundled catalog sets true only for a CTO),
built-in agents (no CEO roles), migrations and seed data (no writes to
this field).
A plain-false rule would remove hiring from those CEOs. With the record,
existing data keeps today's behavior, and no data migration is
necessary.
## Verification
- `cd server && npx vitest run
src/__tests__/agent-permissions-service.test.ts
src/__tests__/authorization-service.test.ts
src/__tests__/agent-permissions-routes.test.ts
src/__tests__/agent-conversations.test.ts` passes (244 tests).
- `teams-catalog-service`, `company-portability` and `built-in-agents`
tests pass (189 tests).
- Red check: the new authorization test fails without the
`authorization.ts` change.
- `npx tsc --noEmit -p server` passes.
- End to end: the chat eval `agents.hire-denied` on the OpenCode runner.
The baseline run (Actions run 42478870236) created Morgan through
`hire_agent`. With this fix (Actions run 42480936881), the agent got the
403, created no agent, and linked the hire form and its permissions
page. The eval clicked the rendered hire-form link.
## Risks
- Behavior change: a CEO whose hiring the board turns off after this
change can no longer hire.
- A CEO that already has a saved false keeps hiring until a board user
turns it off again on the permissions page. The page now shows such a
CEO as on, so the board can see and change it.
- A request that creates a CEO with `canCreateAgents: false` does not
restrict it. The board must turn hiring off on the permissions page.
- A CEO agent whose hiring is denied can no longer import a package that
creates agents. A board user can still import it.
- Other CEO special cases are not hiring routes: `issues.ts` lets a CEO
link approvals to issues, and `agents.ts` gives a CEO task assignment.
`teams-catalog.ts` and `llms.ts` read the normalized permissions, so
they follow the same effective value.
- The denial text is longer. No existing test compares this route's
exact error text.
## Model Used
- Anthropic Claude Opus 5.5 (`claude-opus-5-5`), with tool use and code
execution in Claude Code.
## 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
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
183 lines
10 KiB
TypeScript
183 lines
10 KiB
TypeScript
import { notifyMuseContactVerification } from "../modules/external-agents/index.js";
|
|
import { assertEphemeralAgentInstructions } from "./agent-instructions.js";
|
|
import { notifyStrandedAgentStatus } from "./live-run-recovery-notifications.js";
|
|
import { notifyDeferredExecutionEligibility } from "./deferred-execution-notifications.js";
|
|
import { notifyRunDispatch } from "./run-dispatch-notifications.js";
|
|
import { notifyAttentionRetentionWork } from "./retention-work-notifications.js";
|
|
import { notifySkillVersionPinChange } from "./skill-version-retention-notifications.js";
|
|
import { DELIVERY_QUEUES, notifyDeliveryWork } from "./delivery-work-notifications.js";
|
|
import { notifyExternalConversationSettlement } from "./external-conversation-settlement-notifications.js";
|
|
import { and, eq } from "drizzle-orm";
|
|
import { assets, agentConfigRevisions, agentTaskSessions, agentRuntimeState, type Db } from "@paperclipai/db";
|
|
import { normalizeAgentUrlKey } from "@paperclipai/shared";
|
|
import { normalizePaperclipRunnerAdapterConfig } from "@paperclipai/adapter-utils/server-utils";
|
|
import { conflict, notFound, unprocessable } from "../errors.js";
|
|
import { agentRecordQueries, type UpdateAgentOptions, type AgentConfigurationPatch, type AgentConfigurationRecord, isPlainRecord, buildConfigSnapshot,
|
|
hasConfigPatchFields, changedPendingApprovalConfigFields, diffConfigSnapshot, jsonEqual } from "../lib/agent-records.js";
|
|
import { CEO_HIRING_DENIAL_KEY, ceoHiringDenial, normalizeAgentPermissions } from "../lib/agent-permissions.js";
|
|
import type { ActivityPublication } from "../types/activity-publication.js";
|
|
import { secretService, assertClaudeOAuthBindingInvariant } from "./secrets.js";
|
|
import { agentCredentialService } from "./agent-credentials.js";
|
|
import { clearPrimaryAgent } from "./primary-agent.js";
|
|
import { budgetServiceInTransaction } from "./budgets.js";
|
|
|
|
export async function prepareAgentConfiguration(db: Db, existing: AgentConfigurationRecord, data: AgentConfigurationPatch, options?: UpdateAgentOptions): Promise<AgentConfigurationPatch> {
|
|
await notifyAttentionRetentionWork(db, { companyId: existing.companyId });
|
|
const id = existing.id;
|
|
const { ensureManager, assertNoCycle, assertCompanyShortnameAvailable, assertBuiltInAgentMetadataMutationAllowed } = agentRecordQueries(db);
|
|
if (existing.status === "pending_approval" && !options?.allowPendingApprovalConfigUpdate) {
|
|
const changedFields = changedPendingApprovalConfigFields(agentRecordQueries(db).normalizeAgentRow(existing), data);
|
|
if (changedFields.length > 0) {
|
|
throw conflict("Pending approval agent configuration cannot be changed before board approval", {
|
|
code: "pending_approval_agent_config_frozen",
|
|
agentId: id,
|
|
fields: changedFields,
|
|
});
|
|
}
|
|
}
|
|
|
|
if (data.reportsTo !== undefined) {
|
|
if (data.reportsTo) {
|
|
await ensureManager(existing.companyId, data.reportsTo);
|
|
}
|
|
await assertNoCycle(id, data.reportsTo);
|
|
}
|
|
|
|
if (data.name !== undefined) {
|
|
const previousShortname = normalizeAgentUrlKey(existing.name);
|
|
const nextShortname = normalizeAgentUrlKey(data.name);
|
|
if (previousShortname !== nextShortname) {
|
|
await assertCompanyShortnameAvailable(existing.companyId, data.name, { excludeAgentId: id });
|
|
}
|
|
}
|
|
|
|
if (Object.prototype.hasOwnProperty.call(data, "metadata")) {
|
|
assertBuiltInAgentMetadataMutationAllowed(existing.metadata, data.metadata, options);
|
|
}
|
|
|
|
if (data.appearance?.customAvatarAssetId) {
|
|
const [asset] = await db.select().from(assets).where(and(
|
|
eq(assets.id, data.appearance.customAvatarAssetId), eq(assets.companyId, existing.companyId),
|
|
eq(assets.createdByAgentId, id),
|
|
));
|
|
if (!asset || asset.contentType !== "image/png" || !asset.objectKey.startsWith(`${existing.companyId}/agent-avatars/${id}/`)) {
|
|
throw unprocessable("Use the avatar upload endpoint to set this agent's image");
|
|
}
|
|
}
|
|
const normalizedPatch = { ...data } as AgentConfigurationPatch;
|
|
if (data.permissions !== undefined) {
|
|
// Only the permissions control records a CEO hiring restriction. Keep an
|
|
// existing one unless this write turns hiring on, and never take one from input.
|
|
const incoming = data.permissions && typeof data.permissions === "object" && !Array.isArray(data.permissions)
|
|
? Object.fromEntries(Object.entries(data.permissions).filter(([key]) => key !== CEO_HIRING_DENIAL_KEY)) : data.permissions;
|
|
const denial = ceoHiringDenial(existing.permissions);
|
|
normalizedPatch.permissions = normalizeAgentPermissions(
|
|
denial && (incoming as Record<string, unknown> | null)?.canCreateAgents !== true
|
|
? { ...(incoming as Record<string, unknown>), [CEO_HIRING_DENIAL_KEY]: denial } : incoming,
|
|
);
|
|
}
|
|
if (
|
|
Object.prototype.hasOwnProperty.call(normalizedPatch, "adapterConfig") &&
|
|
isPlainRecord(normalizedPatch.adapterConfig)
|
|
) {
|
|
const normalizedAdapterConfig = await secretService(db).normalizeAdapterConfigForPersistence(
|
|
existing.companyId,
|
|
normalizedPatch.adapterConfig,
|
|
{ adapterType: (normalizedPatch.adapterType ?? existing.adapterType) as string },
|
|
);
|
|
normalizedPatch.adapterConfig = normalizePaperclipRunnerAdapterConfig(
|
|
(normalizedPatch.adapterType ?? existing.adapterType) as string,
|
|
normalizedAdapterConfig,
|
|
);
|
|
} else if (
|
|
Object.prototype.hasOwnProperty.call(normalizedPatch, "adapterType")
|
|
&& isPlainRecord(existing.adapterConfig)
|
|
) {
|
|
normalizedPatch.adapterConfig = normalizePaperclipRunnerAdapterConfig(
|
|
normalizedPatch.adapterType as string,
|
|
existing.adapterConfig,
|
|
);
|
|
}
|
|
if(normalizedPatch.adapterType!==undefined&&normalizedPatch.adapterType!==existing.adapterType
|
|
||normalizedPatch.adapterConfig!==undefined&&!jsonEqual(normalizedPatch.adapterConfig,existing.adapterConfig))
|
|
await notifyMuseContactVerification(db,{companyId:existing.companyId,agentId:existing.id});
|
|
await notifyStrandedAgentStatus(db, { companyId: existing.companyId, agentId: existing.id });
|
|
await notifyRunDispatch(db, { companyId: existing.companyId });
|
|
await notifyDeferredExecutionEligibility(db, { companyId: existing.companyId });
|
|
if (normalizedPatch.runtimeConfig !== undefined || normalizedPatch.reportsTo !== undefined) {
|
|
await notifyDeliveryWork(db, DELIVERY_QUEUES.agentTimers);
|
|
}
|
|
if (normalizedPatch.adapterConfig !== undefined) {
|
|
await notifySkillVersionPinChange(db, existing.companyId, existing.adapterConfig ?? {}, normalizedPatch.adapterConfig);
|
|
}
|
|
assertEphemeralAgentInstructions({ ...existing, ...normalizedPatch });
|
|
return normalizedPatch;
|
|
}
|
|
|
|
export async function completeAgentConfiguration(txDb: Db, existing: AgentConfigurationRecord, updated: AgentConfigurationRecord, normalizedPatch: AgentConfigurationPatch, options: UpdateAgentOptions | undefined, publications: ActivityPublication[]) {
|
|
const id = updated.id;
|
|
const shouldRecordRevision = Boolean(options?.recordRevision) && hasConfigPatchFields(normalizedPatch);
|
|
const beforeConfig = shouldRecordRevision
|
|
? buildConfigSnapshot(agentRecordQueries(txDb).normalizeAgentRow(existing))
|
|
: null;
|
|
if (updated.status === "terminated") {
|
|
await clearPrimaryAgent(txDb, updated.companyId, id);
|
|
}
|
|
|
|
const priorAdapterConfig = isPlainRecord(existing.adapterConfig) ? existing.adapterConfig : {};
|
|
const afterConfig = isPlainRecord(updated.adapterConfig) ? updated.adapterConfig : {};
|
|
const changedExecution = updated.adapterType !== existing.adapterType
|
|
|| (updated.adapterType === "paperclip_runner" && ["provider", "acpxAgent", "model"].some(
|
|
(key) => priorAdapterConfig[key] !== afterConfig[key],
|
|
));
|
|
if (changedExecution) {
|
|
await notifyExternalConversationSettlement(txDb, { companyId: existing.companyId });
|
|
await txDb.delete(agentTaskSessions).where(and(eq(agentTaskSessions.companyId, existing.companyId), eq(agentTaskSessions.agentId, id)));
|
|
await txDb.update(agentRuntimeState).set({ adapterType: updated.adapterType, sessionId: null, stateJson: {}, updatedAt: new Date() })
|
|
.where(and(eq(agentRuntimeState.companyId, existing.companyId), eq(agentRuntimeState.agentId, id)));
|
|
}
|
|
|
|
if (Object.prototype.hasOwnProperty.call(normalizedPatch, "adapterConfig")) {
|
|
await agentCredentialService(txDb).enforceClaudeOAuthBindingClaim(txDb, {
|
|
companyId: existing.companyId, consume: false, environmentId: null,
|
|
childAdapterConfig: updated.adapterConfig, claudeLogin: options?.claudeLogin,
|
|
decision: assertClaudeOAuthBindingInvariant({ adapterType: updated.adapterType,
|
|
nextConfig: updated.adapterConfig, priorConfig: existing.adapterConfig }),
|
|
});
|
|
await agentCredentialService(txDb).syncAgentSecretBindings(
|
|
updated, txDb,
|
|
existing.adapterConfig,
|
|
options?.recordRevision,
|
|
);
|
|
}
|
|
|
|
if (normalizedPatch.budgetMonthlyCents !== undefined) {
|
|
await budgetServiceInTransaction(txDb, publications).upsertPolicy(existing.companyId, {
|
|
scopeType: "agent", scopeId: id, amount: normalizedPatch.budgetMonthlyCents,
|
|
isActive: normalizedPatch.budgetMonthlyCents > 0, windowKind: "calendar_month_utc",
|
|
}, options?.recordRevision?.createdByUserId ?? null);
|
|
}
|
|
const normalizedUpdated = await agentRecordQueries(txDb).getById(updated.id);
|
|
if (!normalizedUpdated) {
|
|
throw notFound("Agent not found");
|
|
}
|
|
|
|
if (shouldRecordRevision && beforeConfig) {
|
|
const afterConfig = buildConfigSnapshot(normalizedUpdated);
|
|
const changedKeys = diffConfigSnapshot(beforeConfig, afterConfig);
|
|
if (changedKeys.length > 0) {
|
|
await txDb.insert(agentConfigRevisions).values({
|
|
companyId: normalizedUpdated.companyId,
|
|
agentId: normalizedUpdated.id,
|
|
createdByAgentId: options?.recordRevision?.createdByAgentId ?? null,
|
|
createdByUserId: options?.recordRevision?.createdByUserId ?? null,
|
|
source: options?.recordRevision?.source ?? "patch",
|
|
rolledBackFromRevisionId: options?.recordRevision?.rolledBackFromRevisionId ?? null,
|
|
changedKeys,
|
|
beforeConfig: beforeConfig as unknown as Record<string, unknown>,
|
|
afterConfig: afterConfig as unknown as Record<string, unknown>,
|
|
});
|
|
}
|
|
}
|
|
}
|