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>
168 lines
9.8 KiB
TypeScript
168 lines
9.8 KiB
TypeScript
import { assertEphemeralAgentInstructions } from "./agent-instructions.js";
|
|
import { initializeDurableAgentFiles } from "./agent-file-durability.js";
|
|
import { notifyAttentionRetentionWork } from "./retention-work-notifications.js";
|
|
import { notifySkillVersionRetention, notifySkillVersionPinChange } from "./skill-version-retention-notifications.js";
|
|
import { agentAppearanceSchema, randomAgentAppearance } from "@paperclipai/shared";
|
|
import { normalizePaperclipRunnerAdapterConfig } from "@paperclipai/adapter-utils/server-utils";
|
|
import { agents, toolConnectionInstalls, principalPermissionGrants, type Db } from "@paperclipai/db";
|
|
import { eq } from "drizzle-orm";
|
|
import { unprocessable } from "../errors.js";
|
|
import { agentRecordQueries, isPlainRecord, configPatchFromApprovalPayload, normalizeRuntimeConfigForNewAgent,
|
|
deduplicateAgentName, type CreateAgentData, type CreateAgentOptions, type AgentConfigurationPatch, type AgentHireRecord } from "../lib/agent-records.js";
|
|
import { CEO_HIRING_DENIAL_KEY, normalizeAgentPermissions, permissionsImplyLowTrust, NEW_STANDARD_AGENT_DEFAULT_GRANT_KEYS,
|
|
newStandardAgentGrantScope } from "../lib/agent-permissions.js";
|
|
import { readBuiltInAgentMarker } from "../lib/built-in-agent-metadata.js";
|
|
import { secretService, assertClaudeOAuthBindingInvariant } from "./secrets.js";
|
|
import { agentCredentialService } from "./agent-credentials.js";
|
|
import { agentIdentityService } from "./agent-identity.js";
|
|
import { initializePrimaryAgent } from "./primary-agent.js";
|
|
import { resolveAgentRunnerTaskDriverForCompany, resolveNewAgentRunnerForCompany } from "./agent-runner-selection.js";
|
|
import { instanceSettingsService } from "./instance-settings.js";
|
|
import { assertProviderApiPlacementPolicy, isProviderApiSetupDraft, resolveProviderApiPlacement } from "./native-runtime/provider-api-placement.js";
|
|
|
|
export async function prepareAgentHire(db: Db, companyId: string, input: CreateAgentData, options?: CreateAgentOptions): Promise<CreateAgentData> {
|
|
await notifyAttentionRetentionWork(db, { companyId });
|
|
const { runner, ...data } = input;
|
|
const selection = options?.runnerResolved
|
|
? { adapterType: data.adapterType ?? "process", adapterConfig: isPlainRecord(data.adapterConfig) ? data.adapterConfig : {} }
|
|
: await resolveNewAgentRunnerForCompany(db, companyId, {
|
|
...data, adapterConfig: isPlainRecord(data.adapterConfig) ? data.adapterConfig : {}, runner,
|
|
});
|
|
data.adapterType = selection.adapterType;
|
|
data.adapterConfig = selection.adapterConfig;
|
|
const { ensureManager, assertBuiltInAgentMetadataMutationAllowed } = agentRecordQueries(db);
|
|
if (data.appearance?.customAvatarAssetId) throw unprocessable("Create the agent before uploading its avatar");
|
|
assertBuiltInAgentMetadataMutationAllowed(null, data.metadata, options);
|
|
if (data.reportsTo) {
|
|
await ensureManager(companyId, data.reportsTo);
|
|
}
|
|
|
|
const existingAgents = await db
|
|
.select({ id: agents.id, name: agents.name, status: agents.status })
|
|
.from(agents)
|
|
.where(eq(agents.companyId, companyId));
|
|
const uniqueName = deduplicateAgentName(data.name, existingAgents.filter(agent => agent.id !== options?.setupAgentId));
|
|
|
|
const role = data.role ?? "general";
|
|
// Only the permissions control records a CEO hiring restriction.
|
|
const requestedPermissions = 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 normalizedPermissions = normalizeAgentPermissions(requestedPermissions, { context: "create" });
|
|
const runtimeConfig = normalizeRuntimeConfigForNewAgent(data.runtimeConfig);
|
|
const adapterType = data.adapterType ?? "process";
|
|
const rawAdapterConfig = isPlainRecord(data.adapterConfig)
|
|
? await secretService(db).normalizeAdapterConfigForPersistence(companyId, data.adapterConfig, { adapterType })
|
|
: {};
|
|
const adapterConfig = normalizePaperclipRunnerAdapterConfig(adapterType, rawAdapterConfig);
|
|
const profile = { adapterType, adapterConfig };
|
|
const providerApiDraft = options?.setupOnly === true && isProviderApiSetupDraft(profile);
|
|
const providerApi = providerApiDraft ? null : resolveProviderApiPlacement({ agent: profile });
|
|
if (providerApi) assertProviderApiPlacementPolicy(await instanceSettingsService(db).getGeneral());
|
|
if (!providerApiDraft && !providerApi && adapterType === "paperclip_runner" && !["openai_dot", "grok_bot", "muse"].includes(String(adapterConfig.provider)) &&
|
|
(await resolveAgentRunnerTaskDriverForCompany(db, companyId, data.defaultEnvironmentId))?.warmTaskVersion === 1) {
|
|
adapterConfig.lifecycleMode = "warm";
|
|
}
|
|
await agentCredentialService(db).enforceClaudeOAuthBindingClaim(db, {
|
|
companyId, consume: true, environmentId: data.defaultEnvironmentId ?? null,
|
|
childAdapterConfig: adapterConfig, claudeLogin: options?.claudeLogin,
|
|
decision: assertClaudeOAuthBindingInvariant({ adapterType, nextConfig: adapterConfig }),
|
|
});
|
|
if (options?.setupAgentId) await notifySkillVersionRetention(db, companyId);
|
|
return { ...data, name: uniqueName,
|
|
appearance: data.appearance == null ? randomAgentAppearance() : agentAppearanceSchema.parse(data.appearance),
|
|
role, adapterType, adapterConfig, permissions: normalizedPermissions, runtimeConfig };
|
|
}
|
|
|
|
export async function initializeAgentHire(txDb: Db, created: AgentHireRecord, options?: CreateAgentOptions) {
|
|
const tx = txDb;
|
|
const companyId = created.companyId;
|
|
assertEphemeralAgentInstructions({ ...created, name: "" });
|
|
await initializeDurableAgentFiles(txDb, created);
|
|
await agentIdentityService(txDb).ensureAgentIdentity(companyId, created.id);
|
|
// New standard agents receive the standard direct grants at activation.
|
|
// Low-trust and bundled agents keep their explicit, narrower grants.
|
|
if (!options?.setupOnly && created.status !== "pending_approval" && !permissionsImplyLowTrust(created.permissions) &&
|
|
!readBuiltInAgentMarker(created.metadata)) {
|
|
await tx.insert(principalPermissionGrants).values(
|
|
NEW_STANDARD_AGENT_DEFAULT_GRANT_KEYS.map((permissionKey) => ({
|
|
companyId,
|
|
principalType: "agent" as const,
|
|
principalId: created.id,
|
|
permissionKey,
|
|
scope: newStandardAgentGrantScope(permissionKey, created.id),
|
|
})),
|
|
).onConflictDoNothing();
|
|
}
|
|
if (options?.aiConnectionInstall) {
|
|
const install = options.aiConnectionInstall;
|
|
const connectionIds = [...new Set([install.connectionId, ...(install.memberConnectionIds ?? [])])];
|
|
await tx.insert(toolConnectionInstalls).values(connectionIds.map(connectionId => ({
|
|
companyId, connectionId,
|
|
targetType: "agent" as const, targetId: created.id,
|
|
createdByUserId: install.createdByUserId,
|
|
}))).onConflictDoNothing();
|
|
}
|
|
await agentCredentialService(txDb).syncAgentSecretBindings(created, txDb);
|
|
if (!options?.setupOnly && options?.createdByUserId && !readBuiltInAgentMarker(created.metadata)) {
|
|
await initializePrimaryAgent(txDb, companyId, options.createdByUserId, created.id);
|
|
}
|
|
}
|
|
|
|
export async function prepareAgentHireApproval(txDb: Db, existing: AgentHireRecord, approvedPayload?: Record<string, unknown> | null): Promise<AgentConfigurationPatch> {
|
|
const approvedPatch = approvedPayload ? configPatchFromApprovalPayload(approvedPayload) : {};
|
|
const patch = { ...approvedPatch } as AgentConfigurationPatch;
|
|
const hasApprovedAdapterConfig = Object.prototype.hasOwnProperty.call(patch, "adapterConfig") && isPlainRecord(patch.adapterConfig);
|
|
if (
|
|
Object.prototype.hasOwnProperty.call(patch, "adapterConfig") &&
|
|
isPlainRecord(patch.adapterConfig)
|
|
) {
|
|
const normalizedAdapterConfig = await secretService(txDb).normalizeAdapterConfigForPersistence(
|
|
existing.companyId, patch.adapterConfig, { adapterType: (patch.adapterType ?? existing.adapterType) as string },
|
|
);
|
|
patch.adapterConfig = normalizePaperclipRunnerAdapterConfig(
|
|
(patch.adapterType ?? existing.adapterType) as string,
|
|
normalizedAdapterConfig,
|
|
);
|
|
} else if (
|
|
Object.prototype.hasOwnProperty.call(patch, "adapterType")
|
|
&& isPlainRecord(existing.adapterConfig)
|
|
) {
|
|
patch.adapterConfig = normalizePaperclipRunnerAdapterConfig(
|
|
patch.adapterType as string,
|
|
existing.adapterConfig,
|
|
);
|
|
}
|
|
if (patch.permissions !== undefined) {
|
|
// The pending-approval activation replays the original hire
|
|
// request, so the new-agent creation default applies.
|
|
patch.permissions = normalizeAgentPermissions(patch.permissions, { context: "create" });
|
|
}
|
|
if (hasApprovedAdapterConfig) {
|
|
await agentCredentialService(txDb).enforceClaudeOAuthBindingClaim(txDb, {
|
|
companyId: existing.companyId, consume: false, environmentId: null,
|
|
childAdapterConfig: patch.adapterConfig,
|
|
decision: assertClaudeOAuthBindingInvariant({ adapterType: patch.adapterType ?? existing.adapterType,
|
|
nextConfig: patch.adapterConfig, priorConfig: existing.adapterConfig }),
|
|
});
|
|
}
|
|
if (patch.adapterConfig !== undefined) await notifySkillVersionPinChange(txDb, existing.companyId, existing.adapterConfig ?? {}, patch.adapterConfig);
|
|
assertEphemeralAgentInstructions({ ...existing, ...patch, name: "" });
|
|
return patch;
|
|
}
|
|
|
|
export async function completeAgentHireApproval(txDb: Db, updated: AgentHireRecord, existing: AgentHireRecord) {
|
|
const tx = txDb;
|
|
await agentCredentialService(txDb).syncAgentSecretBindings(updated, txDb, existing.adapterConfig);
|
|
if (!permissionsImplyLowTrust(updated.permissions) && !readBuiltInAgentMarker(updated.metadata)) {
|
|
await tx.insert(principalPermissionGrants).values(
|
|
NEW_STANDARD_AGENT_DEFAULT_GRANT_KEYS.map((permissionKey) => ({
|
|
companyId: updated.companyId,
|
|
principalType: "agent" as const,
|
|
principalId: updated.id,
|
|
permissionKey,
|
|
scope: newStandardAgentGrantScope(permissionKey, updated.id),
|
|
})),
|
|
).onConflictDoNothing();
|
|
}
|
|
}
|