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>
82 lines
5.0 KiB
Markdown
82 lines
5.0 KiB
Markdown
# Paperclip agent access map
|
|
|
|
This map accompanies the [feature map](../feature-map/README.md). It records APIs,
|
|
agent entry points, permission boundaries and verification for the same capability IDs.
|
|
The [shared contract](../README.md) defines the format and maintenance rules.
|
|
|
|
Use full capability IDs when referring to access contracts outside their file:
|
|
`onboarding/company` means the `company` capability in `onboarding.md` in both maps.
|
|
The [feature index](../feature-map/README.md#browse-features) lists feature and
|
|
capability IDs; [IDs and references](../feature-map/README.md#ids-and-references)
|
|
explains entry-point references and stable naming.
|
|
|
|
## Browse access contracts
|
|
|
|
The same-named feature recipes define navigation and capability IDs. Run
|
|
`node scripts/storybook-catalog.mjs` for the generated
|
|
`maps/generated/agent-access-map.md` index, or browse the
|
|
[published feature guide](https://d1p6rlowie26tp.cloudfront.net/storybook/branches/master/?path=/story/overview-storybook-guide--coverage-guide).
|
|
Add or update the affected companion; there is no central registration or count.
|
|
|
|
Existing baseline source references describe the original inspection, not current
|
|
verification. Record new executed evidence in the PR, issue, or CI artifact with
|
|
its revision and scope. Do not refresh unrelated headers as bookkeeping.
|
|
|
|
## Using an entry
|
|
|
|
Read its Policy and Gaps before selecting an agent path. Native fallback, legacy
|
|
REST/CLI, stdio MCP and a personal assistant connection can have different
|
|
authority and availability. Use a real admitted production binding; a scenario
|
|
declaration is not an installed tool. A `restricted` entry records current
|
|
enforcement and leaves any unresolved delegation decision visible.
|
|
|
|
For API catalog disagreements, follow the route/service authorization and record
|
|
discovery drift. For `not-applicable`, retain the concrete exception and local
|
|
path. Split shared business operations from client-only presentation.
|
|
|
|
Use `maintain-verification-skill` to reconcile changed source and both maps.
|
|
Use `verify-paperclip` and existing API/runner/MCP fixtures to collect the
|
|
permitted-agent and denial evidence; report blocked/not-run coverage honestly.
|
|
Run `node scripts/check-maps.mjs` after editing. The structural check does not
|
|
certify permissions, API catalog coverage, tool admission or live behavior.
|
|
|
|
## Native REST transport
|
|
|
|
The `call_api` parity change reconciles affected baselines against
|
|
`58e16dbddfc9c8d0cf60867f9d9847f0feda055b` and the changes in this PR. Ordinary
|
|
REST operations use the same route authorization as legacy agent REST. Dedicated
|
|
tools remain optional for those operations; protocol endpoints still need their
|
|
existing clients. Board-only routes remain restricted for agent identity.
|
|
|
|
Native `search_api` / `call_api` requires operator rollout admission, a running
|
|
authorized native run, current task assignment and execution-run binding, company
|
|
and budget authority, task privacy, and a permitted work mode. Ask and Plan retain
|
|
mutation restrictions, and runs retain their admitted JWT scope during restart
|
|
recovery even when task mode changes. A waiting
|
|
agent does not gain independent native control just because a REST route exists.
|
|
|
|
Credential-bearing replies, including company exports and their legacy alias,
|
|
stay inline under a 10 MiB limit and use encrypted mutation receipts. Other saved
|
|
API snapshots are limited to the issuing actor and responsible user, plus authorized
|
|
administrators. Artifact uploads enforce the same access checks as downloads;
|
|
private snapshots are excluded from company exports and public company logos.
|
|
Explicit deliverables use the existing sharing path. Native event history,
|
|
checkpoints and completion records omit API bodies while preserving receipt
|
|
metadata and replay digests. Restored webhook secrets use the same encrypted
|
|
receipt and inline response policy as newly created webhook secrets.
|
|
Task image access requires the company boundary and the task permission;
|
|
skill-test and low-trust agents do not need company-wide browsing authority.
|
|
Completion replay applies the same idempotent projection to stored and expected
|
|
payloads; [the run-log guide](../../doc/run-log-events.md) describes its fields.
|
|
|
|
Sources: [API client](../../server/src/services/native-runtime/runner-api-client.ts),
|
|
[catalog](../../server/src/services/native-runtime/runner-api-catalog.ts),
|
|
[native authority](../../server/src/services/native-runtime/paperclip-runner-tool-authority.ts),
|
|
[credential storage classification](../../server/src/services/native-runtime/runner-api-sensitive-response.ts),
|
|
[snapshot access](../../server/src/services/asset-content-access.ts),
|
|
and [history redaction](../../server/src/services/native-runtime/runner-api-log-redaction.ts). The affected entries remain
|
|
`baseline` and `source-only`; this reconciliation does not certify every operation.
|
|
Targeted real-route proof lives in the
|
|
[API integration suite](../../server/src/services/native-runtime/runner-api.integration.test.ts),
|
|
including owned routines, skill tests, scoped secrets, proposals and private export replay.
|