mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-23 09:07:46 +02:00
DottaandPaperclip
9ef434fe79
## 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>
91 lines
5.5 KiB
Markdown
91 lines
5.5 KiB
Markdown
---
|
||
navigation: {"section":"Apps, channels, and extensions","sectionOrder":50,"order":20}
|
||
---
|
||
|
||
# App access and action permissions
|
||
|
||
After connecting an app, an operator decides which agents may use it and whether each action is off, requires approval, or is allowed. Activity and action tests help verify the resulting access.
|
||
|
||
Feature ID: `app-permissions`.
|
||
|
||
Implementation: [app detail](../../ui/src/pages/apps/AppDetail.tsx), [permissions](../../ui/src/pages/apps/app-detail/PermissionsPanel.tsx), [activity](../../ui/src/pages/apps/app-detail/ActivityPanel.tsx).
|
||
|
||
Agent access: [companion](../agent-access-map/app-permissions.md).
|
||
|
||
## Sub-features
|
||
|
||
- `agent-access`: `app-permissions/agent-access` — grant the connection to all or selected eligible agents.
|
||
- `action-policy`: `app-permissions/action-policy` — set off/ask/allowed independently for available actions.
|
||
- `catalog-change`: `app-permissions/catalog-change` — review newly discovered/quarantined actions before enabling them.
|
||
- `test-action`: `app-permissions/test-action` — choose an actor and inputs and inspect a real action result.
|
||
- `account-maintenance`: `app-permissions/account-maintenance` — inspect accounts, reconnect/revoke, and review connection activity.
|
||
|
||
## How to get to it (user POV)
|
||
|
||
### `permissions`
|
||
|
||
Open an app at `/apps/:connectionId/permissions`; this is the default connected-app view.
|
||
|
||
### `test-and-maintain`
|
||
|
||
Use the action test control in Permissions, then the connection’s Activity and available account/advanced controls.
|
||
|
||
## Driving it
|
||
|
||
Preconditions: follow the [baseline](./README.md#before-driving-a-journey). Prepare a connection to a fixture or test provider, two agents, and a harmless action. Record provider and credential ownership.
|
||
|
||
### `permissions`
|
||
|
||
Automated: [app detail](../../ui/src/pages/apps/AppDetail.test.tsx) covers agent/action controls, quarantined actions, and navigation using mocked requests.
|
||
|
||
[Runtime assignment tests](../../server/src/__tests__/agent-runtime-assignments.test.ts)
|
||
use PostgreSQL to verify committed assignment notifications, bounded snapshots,
|
||
rollback, and concurrent AI adoption. The owning lifecycle plugin can read
|
||
standing assignments through `ctx.agents.getRuntime`; this does not grant tool
|
||
execution access or replace task-specific authorization.
|
||
|
||
[Tool-definition runtime tests](../../server/src/__tests__/agent-runtime-tool-definitions.test.ts)
|
||
cover catalog invalidation, scoped policy/profile-entry recipients, ignored
|
||
bookkeeping, profile-entry edits concurrent with setup finalization, and profile
|
||
replacement concurrent with application deletion using PostgreSQL. They do not
|
||
qualify live provider access.
|
||
|
||
[Connector access runtime tests](../../server/src/__tests__/agent-runtime-connector-access.test.ts)
|
||
cover grants, delegation, membership cleanup, referenced vault changes, and
|
||
agent-scoped secret bindings. OAuth and Railway tests exercise the corresponding
|
||
credential lock order. Slack search and membership cleanup tests cover lock
|
||
contention and complete transaction retries. Provider calls use fixtures; no live credentials are
|
||
qualified by this coverage.
|
||
|
||
Manual: Grant one agent access, leave another excluded, and exercise off, ask, and allowed states for a harmless action. Reload between changes. Verify actual denied calls stay denied and ask-first creates a decision rather than executing early.
|
||
|
||
### `test-and-maintain`
|
||
|
||
Automated: [app detail tests](../../ui/src/pages/apps/AppDetail.test.tsx) cover test-dialog/UI contracts. Real provider execution and revocation require the selected provider’s live check.
|
||
|
||
Manual: Run a read-only action with explicit inputs and inspect returned data and activity. Refresh discovery and review new actions. Revoke or disconnect only the disposable credential, then verify subsequent use fails with an actionable reconnect state.
|
||
|
||
For Daytona, opening an older saved catalog discovers the current native
|
||
contract. Removed diagnostic actions disappear from Permissions and agent
|
||
discovery; new or changed actions require review. Existing Off/Allowed choices
|
||
remain in place. [Daytona regressions](../../server/src/__tests__/daytona-connection.test.ts)
|
||
cover shared/personal catalog upgrades, failed refresh, permission preservation,
|
||
run-bound file transfers, and revocation with fixture provider responses.
|
||
|
||
## Gotchas
|
||
|
||
- Connected does not imply an agent has access or an action is allowed.
|
||
- Credential-only connections may replace tool-action controls with account-specific controls.
|
||
- See [connection setup](./connection-setup.md) for auth and [questions and approvals](./questions-and-approvals.md) for pending action review.
|
||
|
||
### Storybook verification
|
||
|
||
#### `catalog-change`
|
||
|
||
Capability ID: `app-permissions/catalog-change`.
|
||
|
||
Scope: ui
|
||
Storybook: Mount PermissionsPanel/AppDetail with quarantined actions, selection/review, refresh pending, empty and failed discovery states. Existing auto-allowed NewToolsAllowed examples are not quarantine review.
|
||
Production: Exercise catalog refresh and new-tool review with permitted/denied actors; unreviewed actions stay quarantined, prior Off/Ask choices survive refresh, and approved review persists.
|
||
Sources: Source: [PermissionsPanel.tsx](../../ui/src/pages/apps/app-detail/PermissionsPanel.tsx), [AppDetail.tsx](../../ui/src/pages/apps/AppDetail.tsx), [tool-access.ts](../../server/src/routes/tool-access.ts). Tests: [AppDetail.test.tsx](../../ui/src/pages/apps/AppDetail.test.tsx), [tool-access-service.test.ts](../../server/src/__tests__/tool-access-service.test.ts), [tool-access-policy-service.test.ts](../../server/src/__tests__/tool-access-policy-service.test.ts)
|