Jannik/PaperClipAI
1
0 Fork 0
mirror of https://github.com/paperclipai/paperclip.git synced 2026-10-23 17:33:51 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
572bef4ba7679451ac1543db25cb8ebd533bf919
PaperClipAI/maps/agent-access-map/cli-operations.md
T
DottaandPaperclip 3bbc2104b6 docs: map missing product and operator capabilities (#16990) 
## 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>
2026-10-20 12:47:41 -05:00

165 lines
7.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# CLI, API clients, and local worktrees — agent access
Product map: [CLI, API clients, and local worktrees](../feature-map/cli-operations.md).
Feature ID: `cli-operations`.
Review date: 2026-10-12. Source commit: `f981fa3cc10cb8663a87dec60345fbff46d54d0a`.
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.
## `context`
Capability ID: `cli-operations/context`.
Review: `baseline`.
API: `not-applicable` — Local CLI configuration has no matching domain REST resource;
explicitly classify local operator configuration.
Agent access: `operator-only` — CLI context/profile options and issued agent
environment.
Policy: CLI preserves the selected bearer identity and run header; installing a CLI does
not grant board rights.
Evidence: `source-only` — [implementation](../../cli/src/commands/client/common.ts#L49)
at the reviewed commit above.
Verification: `not-run` — exercise the listed local workflow in an authorized, owned
operator environment. Verify its isolation and result; do not count local machine
authority as company-agent API access.
Gaps: Local CLI configuration has no matching domain REST resource; explicitly classify
local operator configuration.
## `domain-commands`
Capability ID: `cli-operations/domain-commands`.
Review: `baseline`.
API: `present` — representative operation IDs:
- `GET /api/agents/me`.
- `GET /api/companies/{companyId}/issues`.
Agent access: `available` — CLI client commands with agent bearer; REST and native
tools.
Policy: CLI preserves the selected bearer identity and run header; installing a CLI does
not grant board rights.
Evidence: `source-only` — [implementation](../../cli/src/commands/client/common.ts#L49)
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: Each command reuses API authorization; a command listed in help is not necessarily
allowed to this agent.
## `outputs`
Capability ID: `cli-operations/outputs`.
Review: `baseline`.
API: `present` — representative operation IDs:
- `PUT /api/issues/{id}/documents/{key}`.
- `POST /api/issues/{id}/work-products`.
Agent access: `available` — CLI issue/asset/skill commands; REST; native
document/deliverable tools.
Policy: CLI preserves the selected bearer identity and run header; installing a CLI does
not grant board rights.
Evidence: `source-only` — [implementation](../../cli/src/commands/client/common.ts#L49)
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: Binary transfers, document versions and work-product registration need distinct
assertions.
## `run-controls`
Capability ID: `cli-operations/run-controls`.
Review: `baseline`.
API: `present` — representative operation IDs:
- `GET /api/heartbeat-runs/{runId}`.
- `POST /api/agents/{id}/heartbeat/invoke`.
Agent access: `partial` — CLI run/agent commands; read API; board-only
invocation/control routes.
Policy: CLI preserves the selected bearer identity and run header; installing a CLI does
not grant board rights.
Evidence: `source-only` — [implementation](../../cli/src/commands/client/common.ts#L49)
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: Agent credentials can read eligible runs. Operator invocation/cancellation must
not be counted as ordinary agent access.
## `worktree-instances`
Capability ID: `cli-operations/worktree-instances`.
Review: `baseline`.
API: `not-applicable` — Local checkout and pre-start provisioning use local tools, not
company REST authorization. No new runtime is needed.
Agent access: `operator-only` — CLI worktree/test-drive/dev service commands on an
authorized owned checkout.
Policy: CLI preserves the selected bearer identity and run header; installing a CLI does
not grant board rights.
Evidence: `source-only` — [implementation](../../cli/src/commands/client/common.ts#L49)
at the reviewed commit above.
Verification: `not-run` — exercise the listed local workflow in an authorized, owned
operator environment. Verify its isolation and result; do not count local machine
authority as company-agent API access.
Gaps: Local checkout and pre-start provisioning use local tools, not company REST
authorization. No new runtime is needed.
## `feedback-export`
Capability ID: `cli-operations/feedback-export`.
Review: `baseline`.
API: `present` — GET /api/companies/{companyId}/feedback-traces; GET /api/feedback-traces/{traceId}; GET /api/feedback-traces/{traceId}/bundle. Export writes local files after those authorized reads.
Agent access: `restricted` — company report and trace/bundle reads require board identity and company access. CLI availability and an active agent run do not bypass the route’s board check. Filesystem export is an additional local operator operation.
Policy: Company trace list/detail/bundle checks are company-scoped and board-only; inaccessible trace companies return not found. Issue-scoped feedback routes additionally load the accessible issue. Do not infer task-private filtering for company trace endpoints from those different issue routes. Payload handling uses the existing feedback redaction contract, and local export does not alter sharing consent.
Evidence: `source-only` — reviewed at `9ef434fe79c57d976b8b03b14c5242db270b8320`. [Feedback CLI](../../cli/src/commands/client/feedback.ts), [company trace list](../../server/src/routes/companies.ts), [trace detail/bundle routes](../../server/src/routes/issues.ts), and [feedback service](../../server/src/services/feedback.ts).
Verification: `not-run` — Compare filtered board report, detail, bundle, and exported IDs/content; verify ZIP and local paths. Reject an ordinary agent and another company’s trace. Test issue-scoped authorization separately from company-wide trace access. Confirm --shared-only filters records but performs no sharing mutation.
Gaps: Company-level trace policy and issue-level privacy are distinct source contracts; this baseline does not claim a narrower permission than the routes enforce. Full trace-provider formats and live exports remain unverified.
Reference in new issue View Git Blame Copy Permalink