mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 01:41:42 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The feature map records product entry points and verification recipes. > - The paired agent access map records APIs and permission boundaries for the same capability IDs. > - The new index in #16987 made several missing capabilities easier to find. > - Those gaps hid existing assistant, privacy, cost, and operator workflows. > - This pull request adds 15 capabilities with source references, test scope, and manual checks. > - Readers can find these workflows without treating documentation or structural checks as live proof. ## Linked Issues or Issue Description Refs: #16987. Related map work: #16025 and #16214. A search of related pull requests found no duplicate of these additions. **Issue type** Missing documentation. **Where is the issue?** `maps/feature-map/` and `maps/agent-access-map/`. **What's wrong?** The maps omit public assistant MCP connections, private task and project sharing, subscription fees, cost-recording recovery, agent API keys, keyboard entry points, and several operator CLI workflows. **Suggested fix** Add product recipes and matching access records. Show the full capability IDs in the README index and each page. Keep the existing ID format and all 175 existing IDs. Exclude AI account pools. ## What Changed - Add the `assistant-connections` family with setup, consent, device login, client use, and revocation. - Add `tasks/privacy`, `projects/privacy`, `budgets-costs/subscriptions`, and `budgets-costs/accounting-recovery`. - Add `agents/api-keys`, `agents/managed-agent-setup`, and `navigation-preferences/command-palette`. - Add `cli-operations/feedback-export`, `chat-channels/outbound-email`, and `instance-operations/runtime-setup`. - Pair all 15 additions with access rules, source evidence, manual checks, and explicit coverage gaps. Update the visible index to 35 families and 190 capability IDs. - Add cross-links from existing access, connection setup, search, and CLI recipes. Do not change the schema or add AI account pools. - Clarify that the task Share sheet displays direct and inherited access. Manage inherited access at its ancestor or project source. ## Verification - `node scripts/check-maps.mjs` passes: 35 areas and 190 paired capability IDs, with valid references and contract fields. - `node --test scripts/check-maps.test.mjs scripts/storybook-feature-index.test.mjs` passes: 17 tests. - `node scripts/storybook-feature-index.mjs` and `git diff --check` pass. - A comparison with the base confirms all 175 existing IDs remain and exactly the intended 15 IDs were added. The README index matches the discovered feature metadata. - `node scripts/storybook-catalog.mjs` cannot run because this checkout lacks `storybook/internal/csf-tools` and installed workspace dependencies. - `pnpm -r typecheck`, `pnpm test:run`, and `pnpm build` were attempted. All stopped before their task ran: the pnpm 9.15.4 bootstrap could not fetch and verify its registry packages in this environment. - Source review covers the documented UI, CLI, routes, services, and existing tests. No live browser, provider, or authorization journey was run. New access records remain `baseline`, `source-only`, and `not-run`. - Greptile and the Paperclip reviewer both rate current commit `bb8eb797b0a1dc26256faf2f0e57cbe7abc9adcf` 5/5. The inherited-access review thread is resolved. - [GitHub CI](https://github.com/paperclipai/paperclip/actions/runs/39466772379) passes for that commit, including typecheck, build, unit tests, Runner checks, and browser tests. Browser shard 7 passed after one retry for a runner shutdown. All PR checks are successful, neutral, or skipped. ## Risks - Low runtime risk: this change only edits maps. No application behavior, API, dependency, or schema changes. - Source-reviewed recipes can drift or miss deployment-specific behavior. The records state their limits and require live checks before a capability is marked verified. > 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 Codex, model ID `gpt-6.1-sol`, 475,000-token context window, xhigh reasoning effort, with tool use and code execution. ## 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>
175 lines
13 KiB
Markdown
175 lines
13 KiB
Markdown
---
|
||
navigation: {"section":"Agents and reusable capabilities","sectionOrder":30,"order":10}
|
||
---
|
||
|
||
# Hiring, configuration, and organization
|
||
|
||
Operators hire agents, configure their identity and instructions, assign reporting relationships, and manage their lifecycle. Built-in agents have their own setup and lifecycle constraints.
|
||
|
||
Feature ID: `agents`.
|
||
|
||
Implementation: [hiring](../../ui/src/pages/NewAgent.tsx), [configuration](../../ui/src/components/AgentConfigForm.tsx), [organization](../../ui/src/pages/OrgChart.tsx).
|
||
|
||
Agent access: [companion](../agent-access-map/agents.md).
|
||
|
||
## Sub-features
|
||
|
||
- `hire`: `agents/hire` — choose identity, harness, model, and required account settings; edit
|
||
reporting relationships through the agent configuration afterward.
|
||
- `grok-bot`: `agents/grok-bot` — experimental existing-Bot agent setup through remote OAuth, routine credentials, and an authenticated two-way challenge; current contact, stop and explicit recovery.
|
||
- `instructions`: `agents/instructions` — edit agent configuration and instruction files with durable revisions.
|
||
- `organization`: `agents/organization` — inspect and change reporting relationships through supported controls.
|
||
- `primary-agent`: `agents/primary-agent` — choose a personal primary agent for the company, confirm replacement, and inspect its roster/sidebar and task/chat defaults.
|
||
- `lifecycle`: `agents/lifecycle` — pause/resume or retire an agent while preserving history.
|
||
- `built-in`: `agents/built-in` — configure required agents without treating them as ordinary removable hires.
|
||
- `api-keys`: `agents/api-keys` — create and inspect named agent credentials, copy a new token once, and revoke it without changing agent identity.
|
||
- `managed-agent-setup`: `agents/managed-agent-setup` — probe, create, or adopt a qualified Anthropic managed-agent profile with pinned provider resources and retention acknowledgement.
|
||
|
||
## How to get to it (user POV)
|
||
|
||
### `hire-agent`
|
||
|
||
Use New agent from the roster or `/agents/new`.
|
||
|
||
### `agent-configuration`
|
||
|
||
Open `/agents/:agentId` and the configuration/instruction surfaces it exposes.
|
||
|
||
### `organization`
|
||
|
||
Use the roster’s organization view; `/org` redirects to the roster in the streamlined shell.
|
||
|
||
### `personal-primary-agent`
|
||
|
||
Open an agent profile and choose **Set as my primary**. Inspect its crown on the
|
||
profile/roster and its position in the Agents sidebar, then open a new task or Chat.
|
||
|
||
### `agent-api-keys`
|
||
|
||
Open `/agents/:agentId/api-keys` → **API Keys** with an authenticated person who can manage agents. The operator CLI also supports `paperclipai token agent create -C <company-id> --agent <agent-id> --name <label>`, `token agent list -C <company-id> --agent <agent-id>`, and `token agent revoke <key-id> -C <company-id> --agent <agent-id>`.
|
||
|
||
### `managed-agent-cli`
|
||
|
||
Use the operator command `paperclipai managed-agent setup --company-id <company-id> --profile-key <key> --display-name <name> --api-key-secret-id <company-secret-id> --acknowledge-retention --json`. Supply ANTHROPIC_API_KEY through the process environment. Use `--agent-id`, `--agent-version`, and `--environment-id` to adopt resources, or `--probe` for provider reads without profile persistence. The optional session-list cost ceiling is `--max-session-list-cost-usd`.
|
||
|
||
## Driving it with Playwright and the Paperclip CLI
|
||
|
||
Preconditions: follow the [baseline](./README.md#before-driving-a-journey). Use a disposable company and supported adapter; hiring may require a formal approval.
|
||
|
||
### `hire-agent`
|
||
|
||
Automated: [new agent page](../../ui/src/pages/NewAgent.test.tsx) and [configuration form](../../ui/src/components/AgentConfigForm.render.test.tsx) cover mocked UI behavior.
|
||
|
||
Manual: Hire an agent with a distinct name and role. Complete any required approval, reload the roster, and open its configuration. Confirm manager, adapter, and model persisted; run a small task to prove execution readiness.
|
||
|
||
For a new Codex hire, choose the Codex harness. Automatic selection uses Paperclip
|
||
Runner on a qualified selected target; Advanced offers an explicit Legacy runner
|
||
override. Record the persisted runner and
|
||
underlying harness, rather than treating the displayed Codex name as execution
|
||
proof. See [runtime selection and validation](./runs-adapters.md#adapter-setup)
|
||
and [target qualification](./execution-environments.md#environment-settings).
|
||
|
||
Repeat with an explicit Legacy Codex hire. If approval is required, compare its
|
||
reviewed execution configuration before and after restart and activation; approval
|
||
must retain the reviewed runner. Test an existing Legacy and native agent through
|
||
an unrelated edit, reload and restart: neither is automatically upgraded.
|
||
|
||
Creation defaults also apply to API/CLI hires, built-ins, plugins and new team
|
||
imports. Exports preserve resolved execution choices; a package without a runner
|
||
choice uses the new-agent default, while updating an existing same-harness agent
|
||
preserves its execution. For a native Codex import, edit a model or account binding
|
||
and verify unchanged runtime settings survive; an explicit clear must stay cleared.
|
||
Use the [portability recipe](./companies.md) for package preparation and boundaries.
|
||
|
||
For Claude Code on qualified macOS or GNU/Linux x64/ARM64, submit without a
|
||
runner override and inspect
|
||
saved configuration: `paperclip_runner`, `provider: acpx`, `acpxAgent: claude`,
|
||
and ordinary model `claude-opus-5-5`. The Advanced runner selector can explicitly
|
||
choose Legacy. Keep explicit model/account choices and saved runners on edits.
|
||
Verify useful output and a follow-up after a controller restart; setup success
|
||
alone does not establish session continuity. Unsupported architectures/libc and unknown environment qualification retain
|
||
Legacy. Darwin SSH also defaults to Legacy until automatic matching assets are
|
||
qualified; explicit matching native assets and saved native configurations remain
|
||
supported. Linux ARM64 cloud-image production remains deferred.
|
||
|
||
The current hiring wizard assigns the first hire CEO and subsequent hires
|
||
General reporting to the CEO. Change manager/role afterward through supported
|
||
configuration. Process/HTTP agents can be created through API/CLI but are excluded
|
||
from the hiring picker; API fixture creation does not prove this UI journey.
|
||
|
||
### `agent-configuration`
|
||
|
||
Automated: [instruction service](../../server/src/__tests__/agent-instructions-service.test.ts) and [instruction revisions](../../server/src/__tests__/agent-instruction-revisions.test.ts) cover file/revision contracts.
|
||
|
||
Manual: Save a harmless instruction edit, reload, and verify its revision and effect in the next eligible run. Pause and resume the disposable agent; confirm pause prevents new work and does not erase previous runs.
|
||
|
||
For failed setup, use an unavailable model or invalid command on a disposable agent.
|
||
Confirm the profile names the failed verification step and gives a relevant action.
|
||
Check that it explains automatic retry and offers **Retry now**. Fix the configuration,
|
||
retry, and reload; the failure must disappear only after readiness commits.
|
||
Provider output and credentials must not appear in the lifecycle message.
|
||
|
||
An explicit runner change is a configuration change, with normal revisions and
|
||
session invalidation. Incompatible settings must produce a field-specific error;
|
||
selecting another runner must not silently discard them or change an active run's
|
||
recorded execution. Keep runner choice in Advanced and verify the next eligible
|
||
run separately from historical transcripts.
|
||
|
||
### `organization`
|
||
|
||
Automated: [org chart](../../ui/src/pages/OrgChart.test.tsx) is component evidence. Built-in setup also has [configuration modal tests](../../ui/src/components/ConfigureBuiltInAgentModal.test.tsx).
|
||
|
||
Manual: Inspect a manager and report, change the relationship through the offered controls, and reload both views. Exercise a rejected invalid relationship. Configure a built-in agent and verify it retains its required identity and restrictions.
|
||
|
||
### `personal-primary-agent`
|
||
|
||
Automated: [primary-agent context](../../ui/src/context/PrimaryAgentProvider.test.tsx)
|
||
and [primary-agent routes](../../server/src/__tests__/primary-agent.test.ts)
|
||
cover selection, company/user scope, and request contracts.
|
||
|
||
Manual: Select an available agent, reload, and inspect the retained personal choice.
|
||
Replace it and verify confirmation is required. Leave or terminate the selected
|
||
agent through permitted controls and inspect the unavailable/cleared state.
|
||
Switch company/user to check isolation. Open a task and Chat with a
|
||
valid draft or recent selection; verify those explicit choices take precedence
|
||
over the primary fallback. Opening Chat must not start execution.
|
||
|
||
### `agent-api-keys`
|
||
|
||
Automated: [CLI token tests](../../cli/src/__tests__/token.test.ts) mock create/list/revoke. [Cross-tenant routes](../../server/src/__tests__/agent-cross-tenant-authz-routes.test.ts), [agent permissions](../../server/src/__tests__/agent-permissions-routes.test.ts), and [authentication middleware](../../server/src/__tests__/agent-auth-middleware.test.ts) cover company/key ownership, management permission, responsible-user binding, and denial. They do not prove a browser-created key working against a live instance.
|
||
|
||
Manual: As an authenticated person with agents:create, create a named key for an eligible disposable agent and copy it privately from the once-only display. Make a harmless same-company agent request with that bearer, then reload the Keys tab and verify only metadata remains. Revoke the key through UI or CLI, reload, and retry the exact same bearer: authentication must fail. Inspect key-created/key-revoked activity without token values. Test a board person lacking agent-management permission, an agent caller, another company’s agent, a different agent’s key ID, and a pending-approval/terminated target. A created key without a real responsible-user binding is a failed acceptance prerequisite, not a working credential.
|
||
|
||
Sources: [Keys tab](../../ui/src/pages/AgentDetail.tsx), [key routes](../../server/src/routes/agents.ts), [key service](../../server/src/services/agents.ts), [authentication](../../server/src/middleware/auth.ts), and [CLI token commands](../../cli/src/commands/client/token.ts).
|
||
|
||
### `managed-agent-cli`
|
||
|
||
Automated: [Managed-agent CLI](../../cli/src/__tests__/managed-agent.test.ts) uses mocked provider/API responses. [Profile route authorization](../../server/src/__tests__/managed-agent-profile-routes-authz.test.ts) and [remote profiles](../../server/src/services/remote-agent-profiles.test.ts) cover actor/company checks and qualification. They do not establish provider provisioning or a useful managed task.
|
||
|
||
Manual: Start with known adopted provider IDs in an authorized disposable provider account. Run --probe and verify only provider reads: no resources are created and no Paperclip profile is written. Reject unsafe tools/network/package configuration, an unsupported model, duplicate profile matches, a missing retention acknowledgement, and a malformed secret UUID. During persistence, reject missing, inactive, or foreign-company secret references. Then create or adopt a locked profile in a disposable company; inspect its pinned version, model, environment, retention attestation, and cost ceiling through the profile API. Repeat setup and verify resource reuse. Reject viewer/agent writes and foreign-company references. Qualify useful task execution separately through the runtime recipe; a successful probe is not execution acceptance.
|
||
|
||
Sources: [Managed-agent CLI](../../cli/src/commands/managed-agent.ts), [profile routes](../../server/src/routes/managed-agent-profiles.ts), [profile service](../../server/src/services/managed-agent-profiles.ts), and [runtime validation](./runs-adapters.md).
|
||
|
||
## Gotchas
|
||
|
||
- Managed-agent probing is read-only at the provider and does not persist a Paperclip profile. The explicit retention acknowledgement remains required even for probe.
|
||
|
||
- Agent keys, human CLI tokens, and personal assistant OAuth grants are different credentials. Never include a key’s plaintext token in screenshots, logs, or verification artifacts.
|
||
|
||
- A roster entry is not proof of an authenticated or invokable adapter.
|
||
- Pending hires may live in approval/task surfaces rather than the active roster.
|
||
- Skill and tool grants are separate: see [skills](./skills.md) and [app permissions](./app-permissions.md).
|
||
- A personal primary agent is a per-user/company preference. It does not change
|
||
reporting lines, stars, permissions, or another person's primary agent.
|
||
|
||
### `connect-grok-bot`
|
||
|
||
Choose **Invite an external agent → Grok Bot**, identify the Bot by its desktop name, connect its remote MCP plugin, configure a webhook-only routine, and verify delivery plus authenticated reply. Save & exit resumes the same agent. Keep pairing codes in browser authorization and routine credentials in Paperclip’s fields. A working Bot web URL is not required.
|
||
|
||
Prerequisites: authenticated public HTTPS, Assistant connections (MCP), Paperclip Runner and Grok Bot experimental settings. Cloud uses its normal managed Runner environment. Provider usage is unknown. Routine uncertainty blocks new assignments until explicit inspection and recovery; stopping work revokes Paperclip authority without confirming remote termination.
|
||
|
||
Evidence: source implementation and focused protocol tests; real provider assigned/proactive workflows and deployed managed acceptance remain release gates.
|
||
### Documentation scope: Agents, organization, and runtime setup
|
||
|
||
Per-harness/model/account capabilities, every instruction-file error, and complete built-in-agent lifecycle variants remain separate qualification matrices.
|