mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-23 09:07:46 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Its feature map describes user journeys and their verification paths. > - The map already defines feature IDs and full capability IDs. > - The README and child pages did not show those IDs consistently. > - Readers need those IDs to connect issues, tests, stories, and evidence. > - This pull request adds a recipe index and displays the existing IDs. > - The benefit is clear references across the product and agent access maps. ## Linked Issues or Issue Description **Issue type** Missing documentation. **Where is the issue?** `maps/feature-map/README.md`, the child recipes, and their agent access companions. **What's wrong?** The README sends readers to Storybook to browse features. Child pages show local keys, such as `installation`, without the full `plugins/installation` ID. Readers must inspect the generator to find the full reference. **Suggested fix** List recipe links and existing IDs in the README. Show each feature ID and full capability ID in its child pages. Explain capability IDs and entry-point references. Keep the current keys and anchors. Related work: Refs #15288. Refs #16052. Refs #15983. No duplicate open PR or issue was found by title search. ## What Changed - Add an index grouped by feature area. It lists every recipe, feature ID, and full capability ID. - Explain how IDs are formed and used in issues, tests, Storybook, and evidence. - Add feature IDs to all product recipes and agent access companions. - Show full capability IDs beside recipe keys and below access and Storybook guidance headings. - Preserve existing keys, heading anchors, and generated ID values. Keep the latest upstream company capability in the index. ## Verification - `node scripts/check-maps.mjs` passes for 34 feature families and 175 capability IDs. - `node --test scripts/check-maps.test.mjs scripts/storybook-feature-index.test.mjs` passes all 17 tests. - `node scripts/storybook-feature-index.mjs` passes on this checkout and generates the feature indexes and overview inputs. - `git diff --check` passes. - A source comparison confirms that the README matches the recipe index. After removal of the added ID labels, all 68 child pages match the upstream prose and headings. - Full workspace checks were attempted: `pnpm -r typecheck`, `pnpm test:run`, and `pnpm build`. They could not start because the local pnpm wrapper could not fetch and verify the pinned pnpm 9.15.4 release. This checkout also has no workspace dependencies installed. - `node scripts/storybook-catalog.mjs` could not run because `storybook/internal/csf-tools` is not installed. The direct map and index checks above pass without that dependency. - Remote typecheck, release-registry, and full build checks passed. The first attempts of [server shard 3/12](https://github.com/paperclipai/paperclip/actions/runs/39460473910/job/118758430448) and [server shard 12/12](https://github.com/paperclipai/paperclip/actions/runs/39460473910/job/118758429932) stopped after their runners received a shutdown signal. The test steps were canceled. GitHub rejects the rerun request with HTTP 403: "The workflow run containing this job is already running". Five other CI jobs remain active. The next action is to rerun the two interrupted shards after workflow 39460473910 ends. No application changes were made to address these runner interruptions. - To inspect the result, open the feature-map README, follow a recipe link, and compare its full capability IDs with its access companion. ## Risks - Low risk. The change updates map documentation only. It changes no application code or ID schema. - The readable README index and child labels repeat source IDs. Keep them aligned when a capability changes. - Generated capability descriptions now include the visible ID prefix. Generated IDs, labels, navigation order, and verification fields remain the same. - Full local workspace checks and catalog generation remain unverified for the environment reasons above. > 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 `gpt-6.1-sol`, with a 475,000-token context window and `xhigh` reasoning effort. The model used local file tools, shell commands, and GitHub CLI access. ## 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 - [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>
269 lines
14 KiB
Markdown
269 lines
14 KiB
Markdown
# Execution workspaces, services, and files — agent access
|
|
|
|
Product map: [Execution workspaces, services, and files](../feature-map/workspaces.md).
|
|
|
|
Feature ID: `workspaces`.
|
|
|
|
Lost-source reconstruction adds the board-only
|
|
`POST /api/issues/{id}/recovery-actions/reconstruct-workspace` action. It requires
|
|
`runtime:manage` and ordinary task visibility. Agents cannot authorize it. The
|
|
result is a durable fresh-session admission request, subject to current execution
|
|
gates. It grants no additional tool access, budget, work window or permission to
|
|
repeat completed actions. Attachments must belong to the same task and company.
|
|
The original failed run and lost-export evidence remain unchanged.
|
|
Later native run-only cancellations can coexist only with confirmed lease stops,
|
|
board file-only repair and an external-action outcome of `not_performed`.
|
|
Their immutable evidence is checked again at dispatch. Historical cancellation
|
|
retention runs internally and grants no new agent operation or authority.
|
|
|
|
Review date: 2026-10-12. Source commit: `58e16dbddfc9c8d0cf60867f9d9847f0feda055b`.
|
|
Native REST transport reconciled in this change; see the
|
|
[shared transport contract](README.md#native-rest-transport).
|
|
|
|
This is a source-reviewed baseline of representative operations and known gaps.
|
|
Each capability needs operation-level review before its entire scope can be
|
|
qualified. No live agent execution is claimed. Follow the [map contract](../README.md)
|
|
for format, permission checks, evidence and maintenance.
|
|
|
|
## `binding`
|
|
|
|
Capability ID: `workspaces/binding`.
|
|
|
|
Review: `baseline`.
|
|
|
|
API: `present` — representative operation IDs:
|
|
|
|
- `GET /api/issues/{id}/heartbeat-context`.
|
|
- `GET /api/execution-workspaces/{id}`.
|
|
- `GET /api/issues/{id}/workspace` inspects the durable task binding.
|
|
- `PUT /api/issues/{id}/workspace` requests the next binding.
|
|
- `GET /api/companies/{companyId}/execution-workspaces?summary=true&selectableForTask=true`
|
|
lists authorized task-selectable workspaces.
|
|
|
|
Agent access: `available` — Native get_task_context / REST / CLI / MCP workspace read.
|
|
|
|
The task-bound native tools `get_workspace`, `list_workspaces`, and
|
|
`select_workspace` use the ordinary authenticated APIs. Legacy agents can call
|
|
those APIs with their admitted run token. These paths do not require a project.
|
|
|
|
Policy: Company/project/workspace visibility and runtime authority; active run, trust
|
|
preset and task ownership where required.
|
|
|
|
Task workspace writes require `issue:mutate`, an active owned task/run for agents,
|
|
and current source visibility. Shared physical roots also require source-project
|
|
workspace write authority. Accepting a new pending choice advances its binding
|
|
revision; superseded retries fail while current-choice retries remain idempotent.
|
|
Binding revisions and request keys fence retries;
|
|
selection applies at the next normal admission without interrupting a live run.
|
|
|
|
Admission checks current task/run authority and the persisted selected configuration.
|
|
It does not inventory physical aliases or authorize historical sources/readers.
|
|
Explicit workspace-record selection and full workspace metadata disclosure retain
|
|
app-record privacy. Existing isolated remote-source receipts remain restorable;
|
|
new preparation does not create a remote fallback due to historical file ownership.
|
|
Historical `workspace_source_restricted` failures retain existing recovery support.
|
|
An authorized board recovery through `POST /api/issues/{id}/recovery-actions/resolve`
|
|
can schedule a server-owned `recovery` selection for the latest restricted-source
|
|
failure only when its saved evidence proves provider work never started. The
|
|
selection requires task mutation and configured-source access and applies at normal
|
|
admission. It keeps task environment settings and never reads or deletes the denied
|
|
checkout. Pause, budget, approval, interaction, dependency, and ownership gates
|
|
remain effective. Repeated resolution of the same action does not enqueue another
|
|
run. Agents cannot mint recovery provenance through the workspace selection API;
|
|
they can observe the existing recovery action and request board recovery.
|
|
Local paths, unsupported transports and credential-bearing URLs are not fallback
|
|
sources. Company/task/remote bindings, real paths, Git storage and the exact origin
|
|
are revalidated for reuse, cleanup and reopening. A failed save removes only the
|
|
owned task worktree. The [isolated-source service](../../server/src/services/isolated-remote-workspace-source.ts)
|
|
and its local regression tests establish source and lifecycle boundaries; live
|
|
agent/provider qualification remains separate.
|
|
Reconstructable Git expiration adds no agent endpoint or permission. It records
|
|
company/workspace/repository identity and an exact commit before removing owned
|
|
cache files. Existing task/workspace reopening retains current company, source,
|
|
and trust checks. Missing upstream access returns a retryable error; it does not
|
|
choose a newer commit or grant access to another company's source. Shared project
|
|
bases and unresolved recovery remain protected. Local lifecycle evidence is in
|
|
[expiration tests](../../server/src/__tests__/git-workspace-expiration.test.ts).
|
|
|
|
Only directly selected configuration policies participate in current execution trust.
|
|
Physical aliases and historical source projects do not contribute filesystem policy.
|
|
The
|
|
authoritative sandbox or SSH selection suppresses configured and built-in
|
|
controller worktree and runtime provisioning regardless of task trust, app configuration
|
|
write grants or board sponsorship. Genuine isolated worktrees still permit
|
|
authorized read-only source copying. Configuration write permission does not authorize
|
|
controller execution. Explicit, channel, inherited, foreign or nondefault isolated
|
|
source choices remain copy-only for controller provisioning even on local runs.
|
|
Their deny-only workspace marker survives metadata and binding changes; a board
|
|
reopen does not turn it into approval. Implicit trusted local defaults and explicit
|
|
SSH remote provisioning retain their existing placement; no new sandbox provision transport
|
|
is claimed. The implicit default follows task creation: configured policy pointer,
|
|
then primary source, creation time and ID. A missing or foreign configured source
|
|
does not authorize controller hooks. This precedence neither changes existing
|
|
creation validation nor rotates bindings or clears retained copy-only markers.
|
|
Closed-worktree reopening checks current task, agent, organizational and source policies without assuming a future driver. Effective low-trust reopens suppress configured and built-in host scripts. Returned checkpoints must have directory parents for every nested entry before merging, including unchanged entries; invalid output leaves retained host files intact and keeps recovery evidence.
|
|
|
|
Skipping the host scan for a fully unchanged returned snapshot grants no new
|
|
access. The merge still holds its canonical writer lock and runs both authority
|
|
and publication hooks. Denials still propagate, and checkpoint/archive validation
|
|
is unchanged. [Regression coverage](../../packages/adapter-utils/src/workspace-restore-unchanged.test.ts)
|
|
is source-level evidence only.
|
|
Child creation by an admitted agent checks an explicit prospective-task context before the child is saved. The creator run must have an authoritative saved policy and a verified company/agent/parent lineage. Current parent, prospective child and selected source configuration policies must fit that boundary. This creation path does not relax exact task/run checks for existing-task writes. The [child trust regression](../../server/src/__tests__/task-workspace-child-trust.test.ts) is automated source-level evidence, not live agent qualification.
|
|
Source review for these additions: PR #15749 and
|
|
[task workspace routes](../../server/src/routes/task-workspaces.ts),
|
|
[native authority](../../server/src/services/native-runtime/paperclip-runner-tool-authority.ts),
|
|
and [semantic transport](../../server/src/services/task-workspace-tools.ts).
|
|
|
|
Evidence: `source-only` —
|
|
[implementation](../../server/src/routes/workspace-runtime-service-authz.ts#L76) at the
|
|
reviewed commit above.
|
|
|
|
Verification: `not-run` — exercise a listed permitted operation with actual agent
|
|
credentials/run context; inspect its result and applicable persistence/attribution.
|
|
Assert the relevant denied actor, owner, company or mode from Policy. Review the
|
|
remaining operations before qualifying the whole capability.
|
|
|
|
Gaps: Run/task context identifies its actual realized workspace; record existence is not
|
|
a running service.
|
|
|
|
## `provisioning`
|
|
|
|
Capability ID: `workspaces/provisioning`.
|
|
|
|
Source preparation keeps its dedicated lock connection active during work on
|
|
other connections. It preserves company/source exclusion and existing admission
|
|
authority; it adds no agent API or permission. The
|
|
[source-lock regression](../../server/src/services/isolated-remote-workspace-source-lock.test.ts)
|
|
covers PostgreSQL idle timeout, competing preparation, ordinary pool availability,
|
|
and failure cleanup. Deployed agent recovery requires separate live evidence.
|
|
|
|
Review: `baseline`.
|
|
|
|
API: `present` — representative operation IDs:
|
|
|
|
- `GET /api/execution-workspaces/{id}`.
|
|
- `GET /api/execution-workspaces/{id}/workspace-operations`.
|
|
- `POST /api/issues/{id}/workspace/repositories` requests repository preparation.
|
|
|
|
Agent access: `partial` — REST / native call_api reads; task/project assignment triggers
|
|
server provisioning.
|
|
|
|
Native `prepare_repository` and admitted legacy REST callers can request a
|
|
catalog repository or validated repository URL for their current task.
|
|
Preparation occurs at normal admission; the agent cannot supply a host path or
|
|
controller identity. Current selected-configuration permissions, responsible-user authority, trust
|
|
restrictions, immutable receipts, and concrete binding/path integrity are checked
|
|
before acquisition and publication. Low-trust callers cannot trigger a
|
|
new controller-side Git acquisition. Evidence remains source-only here; focused
|
|
[repository tests](../../server/src/__tests__/task-workspace-repositories-trust.test.ts)
|
|
are separate from live agent qualification.
|
|
|
|
Policy: Company/project/workspace visibility and runtime authority; active run, trust
|
|
preset and task ownership where required.
|
|
|
|
Evidence: `source-only` —
|
|
[implementation](../../server/src/routes/workspace-runtime-service-authz.ts#L76) at the
|
|
reviewed commit above.
|
|
|
|
Verification: `not-run` — exercise a listed permitted operation with actual agent
|
|
credentials/run context; inspect its result and applicable persistence/attribution.
|
|
Assert the relevant denied actor, owner, company or mode from Policy. Review the
|
|
remaining operations before qualifying the whole capability.
|
|
|
|
Gaps: Observing readiness exists. Creating host commands or arbitrary provision targets
|
|
is a separate protected operation.
|
|
|
|
## `services`
|
|
|
|
Capability ID: `workspaces/services`.
|
|
|
|
Review: `baseline`.
|
|
|
|
API: `present` — representative operation IDs:
|
|
|
|
- `POST /api/execution-workspaces/{id}/runtime-services/{action}`.
|
|
|
|
Agent access: `available` — Authorized agent REST / native `call_api` / CLI runtime
|
|
service controls and existing stdio MCP controls.
|
|
|
|
Policy: Company/project/workspace visibility and runtime authority; active run, trust
|
|
preset and task ownership where required.
|
|
|
|
Evidence: `source-only` —
|
|
[implementation](../../server/src/routes/workspace-runtime-service-authz.ts#L76) at the
|
|
reviewed commit above.
|
|
|
|
Verification: `not-run` — exercise a listed permitted operation with actual agent
|
|
credentials/run context; inspect its result and applicable persistence/attribution.
|
|
Assert the relevant denied actor, owner, company or mode from Policy. Review the
|
|
remaining operations before qualifying the whole capability.
|
|
|
|
Gaps: No dedicated production control_workspace_service binding. Generic native
|
|
calls retain runtime trust and workspace/task scope checks. Optional MCP availability
|
|
must be recorded.
|
|
|
|
## `files-git`
|
|
|
|
Capability ID: `workspaces/files-git`.
|
|
|
|
Review: `baseline`.
|
|
|
|
API: `present` — representative operation IDs:
|
|
|
|
- `GET /api/issues/{issueId}/file-resources/content`.
|
|
- `GET /api/issues/{issueId}/file-resources/list`.
|
|
|
|
Agent access: `partial` — Authorized workspace filesystem tools; Dot workspace bridge
|
|
when enabled; board file-resource HTTP UI.
|
|
|
|
Policy: Company/project/workspace visibility and runtime authority; active run, trust
|
|
preset and task ownership where required.
|
|
|
|
Evidence: `source-only` —
|
|
[implementation](../../server/src/routes/workspace-runtime-service-authz.ts#L76) at the
|
|
reviewed commit above.
|
|
|
|
Verification: `not-run` — exercise a listed permitted operation with actual agent
|
|
credentials/run context; inspect its result and applicable persistence/attribution.
|
|
Assert the relevant denied actor, owner, company or mode from Policy. Review the
|
|
remaining operations before qualifying the whole capability.
|
|
|
|
Gaps: Files panel HTTP requires board. Agents can use their admitted workspace file
|
|
tools; remote/Dot scope and Git command availability differ.
|
|
|
|
Task-bound file reads authorize the current task, company, and concrete binding;
|
|
selected project roots require selected configuration access. Historical task,
|
|
reader, physical-root, and directory acquisition classifications have no effect.
|
|
Root containment and symlink escape checks remain, and attachments, task records,
|
|
workspace metadata, and operation logs retain their app-data privacy.
|
|
|
|
## `closure`
|
|
|
|
Capability ID: `workspaces/closure`.
|
|
|
|
Review: `baseline`.
|
|
|
|
API: `present` — representative operation IDs:
|
|
|
|
- `PATCH /api/execution-workspaces/{id}`.
|
|
- `GET /api/execution-workspaces/{id}/close-readiness`.
|
|
- `POST /api/execution-workspaces/{id}/reconcile-branch`.
|
|
|
|
Agent access: `partial` — REST / native fallback for permitted update; CLI workspace;
|
|
reconcile-branch requires board.
|
|
|
|
Policy: Company/project/workspace visibility and runtime authority; active run, trust
|
|
preset and task ownership where required.
|
|
|
|
Evidence: `source-only` —
|
|
[implementation](../../server/src/routes/workspace-runtime-service-authz.ts#L76) at the
|
|
reviewed commit above.
|
|
|
|
Verification: `not-run` — exercise a listed permitted operation with actual agent
|
|
credentials/run context; inspect its result and applicable persistence/attribution.
|
|
Assert the relevant denied actor, owner, company or mode from Policy. Review the
|
|
remaining operations before qualifying the whole capability.
|
|
|
|
Gaps: Closure/readiness exists; not every workspace can be reopened, and branch
|
|
reconciliation has a board boundary.
|