DottaandPaperclip
7d9b93aee2
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Contributors use the feature map to understand and verify product capabilities. > - Agents need APIs and usable entry points within their permission boundaries. > - Product recipes and agent access need separate records with shared capability IDs. > - This pull request establishes that contract and gives maintenance ownership of both maps. > - The benefit is repeatable access review without changing product behavior or permissions. ## Linked Issues or Issue Description Refs: #15983, which added the portable verification skills and updated the feature map. This is its contract-only follow-up. Related: #15288 added the original feature map. **Issue type** Missing documentation and maintenance contract. **Where is the issue?** The product map, its missing agent access companions, and the verification skills. **What's wrong?** There is no shared convention for API presence, agent entry points, permission boundaries, access gaps, or evidence. An API declaration does not prove that a permitted native or remote agent can use it. **Suggested fix** Keep the product and agent access maps as siblings under `maps/`. Reuse capability IDs. Record representative source inventory separately from operation review and live proof. Keep both maps aligned through the maintenance skill. ## What Changed - Move the existing product map to `maps/feature-map/`. Preserve its recipes and Poteto format. Update relative links and add companion links. - Add `maps/agent-access-map/` with 35 area files and 171 matching capability IDs. Seed representative API operations, agent paths, policies and known gaps from the reviewed source inventory. Mark entries as `baseline`, `source-only`, and live verification `not-run`. - Define the shared contract in `maps/README.md`. Track API presence, agent availability, policy, evidence and review depth separately. Require operation enumeration before marking a broad capability operation-reviewed. - Extend `maintain-verification-skill` to reconcile both maps and inspect actual route policy and production tool admission. Update creation, verification, notices and contributor references to use the shared contract. - Add `scripts/check-maps.mjs` and ten regression tests. Check matching areas/IDs, indexes, references, contract fields, API method/path examples, justified exceptions and evidence-state consistency. - Keep the coverage inventory unchanged. Preserve skill invocation policies and both MIT license blocks. No product API, permission, UI, runtime helper, migration, dependency or workflow changes. ## Verification - Passed: `node scripts/check-maps.mjs` reports 35 paired areas and 171 matching capability IDs. All local map references resolve. - Passed: `node --test scripts/check-maps.test.mjs` runs ten tests. Fixtures cover missing companions, renamed/orphan/duplicate IDs, broken references, missing operation fields, empty exceptions, missing API examples, empty policy fields, and verified evidence without passed verification. - Passed: metadata validation for all three verification skills. Skill and contributor links resolve. Invocation policies and both license blocks are unchanged. - Compared relocated recipes with current master. Contents differ only in relative links and companion links. `coverage.json` is byte-for-byte unchanged. Master's updated read-only interaction test reference is retained. - Passed: `git diff --check`. The branch starts from current master and contains only this contract change. - Repository-wide typecheck, tests and build were not run locally for this documentation and Node structural-check scope. Live agent access was not exercised. Those gaps are explicit in the baseline entries; the structural check does not certify behavior. CI and automated review are pending. ## Risks - The companions are representative source baselines. They are not complete operation inventories or passed agent journeys. - The checker cannot establish actual permissions, native tool admission, operation completeness or truthful live evidence. Maintenance must inspect source and verify with the actual permitted agent context. - External links to the old product-map directory may need updates. Repository references have been updated. - Existing access gaps and board/user restrictions remain recorded. This contract does not change authority or implement missing paths. ## Model Used OpenAI GPT-6 through Codex assisted with this change. The session does not expose the exact serving model ID, configured context-window size, or reasoning setting. Capabilities used: source analysis, file edits, shell commands, and structural regression tests. ## 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 - [ ] 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>
Paperclip feature map
Start here when reproducing a user-facing bug, verifying a change, or deciding which surfaces a fix must cover. Each recipe describes what a person can do, where they can do it, the expected result, and the evidence needed to verify it. Product behavior is still governed by the implementation spec.
The sibling agent access map records APIs, agent entry points and permission boundaries for the same capability IDs. Follow the shared map contract when maintaining either map.
Features
The map is organized by user capability, not by source file. It covers 35 feature families across the product, CLI, and operator workflows, checked against source on 2026-10-12. Experimental and developer-only surfaces are labeled explicitly. Each recipe includes sub-features, current entry points, automated evidence, manual verification steps, and gotchas.
Getting started and access
| Feature | What it covers |
|---|---|
| Onboarding and first work | Instance setup, company wizard, first agent and task. |
| Login, invitations, and access | Sessions, bootstrap, membership, roles, and CLI authorization. |
| Companies and portability | Company switching/settings, archival, package import/export. |
Tasks and conversations
| Feature | What it covers |
|---|---|
| Task creation and lifecycle | Creation, assignment, lists, properties, comments, and completion. |
| Delegation, dependencies, and signoff | Child work, prerequisites, reviewers, and task-tree controls. |
| Inbox, decisions, and search | Personal triage, decision queues, unread/blocked views, and search. |
| Agent conversations and project handoff | Persistent conversations, discovery, handoff, and gated board chat. |
| Questions and approvals | Question/plan responses, formal approvals, and app-tool review. |
| Steering and queued messages | Follow-ups, queue edits, interruption, and pause/resume. |
| Documents, attachments, and work products | Versioned documents, annotations, files, outputs, and artifact library. |
Agents and reusable capabilities
| Feature | What it covers |
|---|---|
| Hiring, configuration, and organization | Agent identity, instructions, reporting lines, lifecycle, and built-ins. |
| Runs, harnesses, and model accounts | Adapter/model setup, account validation, transcripts, and run history. |
| Skills and Skill Studio | Discovery, sources, authoring, revisions, tests, and agent policies. |
| Team packages and installation | Catalog preview/install via CLI/API; catalog UI availability called out. |
Projects and execution
| Feature | What it covers |
|---|---|
| Projects and repositories | Project lifecycle, task context, repository configuration, and defaults. |
| Goals and work alignment | Goal hierarchy, ownership, status, and project/task context. |
| Workspaces, services, and files | Provisioning, task bindings, services/logs, Git/files, and closure. |
| Execution environments | Local, SSH, sandbox providers, target probes, and custom images. |
| Recovery | Stopped work, workspace repair, bounded continuation, and reconnect. |
Apps, channels, and extensions
| Feature | What it covers |
|---|---|
| Connection setup | Catalog, MCP links, task requests, authentication, and setup resumption. |
| App access and action permissions | Agent grants, off/ask/allowed actions, discovery, tests, and revocation. |
| External chat and email | Provider-specific identity, threads, files, delivery, and endpoint upkeep. |
| Tool gateways and access profiles | Tool exposure, client configuration, tokens, profiles, and activity. |
| Secrets and proposals | Company/user credentials, grants, proposals, and vault import. |
| Plugins | Installation/configuration, contributed pages/tools, and lifecycle. |
Automation and structured work
| Feature | What it covers |
|---|---|
| Routines, schedules, and triggers | Definitions, variables, scheduled/webhook/manual runs, and history. |
| Pipelines, review queues, and learnings | Experimental stages, automation, items, review, and learning records. |
| Cases | Experimental structured fields, relationships, revisions, and task links. |
| Status cards | Experimental summaries, watched work, refresh history, and settings. |
Oversight and operation
| Feature | What it covers |
|---|---|
| Costs and budgets | Spend reports, scoped limits, incidents, hard stops, and resumption. |
| Dashboards and audit trails | Company health, live work, activity, runs, routines, and timeline. |
| Navigation, profile, and announcements | Sidebar state, favorites/recents, personal identity, and dismissals. |
| Instance operations | Installation, updates, service health, configuration, and backups. |
| CLI/API and local worktrees | Explicit context, resource commands, outputs, runs, and isolated instances. |
Contributor surfaces
| Feature | What it covers |
|---|---|
| Developer previews and diagnostic labs | Design examples, interaction fixtures, performance checks; not production acceptance. |
These are verification instructions, not a claim that every journey passed a live test. A component test proves its component; a scripted provider proves that fixture integration. Record executed results separately from the map.
Before driving a journey
- Use this checkout's isolated test drive for manual product checks. It creates a temporary instance and prints its URL and data directory. Do not guess that a server on port 3100 belongs to you.
- Record the commit, URL, company, login role, relevant experimental settings, adapter, runtime mode, and live versus simulated dependencies. Use disposable tasks and provider resources. A fresh test drive creates a company and CEO, but no task or first run.
- Use the current navigation and company prefix. Paths in recipes omit that prefix. Record whether the streamlined or production shell is selected; Agent Chat, chat connectors, and the combined Inbox/Tasks view have separate gates. A hidden surface is an unmet prerequisite, not a successful test.
- Run the smallest relevant test first. Vitest commands below run from the repository root after installing dependencies. Playwright recipes use their named configuration and its isolated environment, not an unrelated running instance. Reserve expensive runner/provider tests for the behavior at issue.
- Exercise the actual user action, inspect its result, reload, and verify the persisted state or continuation. Use read-only API checks to corroborate UI evidence; creating state through the API does not prove the creation UI.
For agent-driven acceptance work, start with the Paperclip verification skill for an isolated launch, ownership/readiness checks, browser driving, evidence, and cleanup. It uses this directory as its feature map. The existing dev-workspace run/verify skill and evaluation skill describe runtime ownership and evidence handling. Reuse them; this map introduces no environment launcher, credentials, scheduled job, or second test framework.
Evidence contract
Report each entry point as passed, failed, blocked (with its missing prerequisite), or not run. Include the feature filename and entry-point ID, commit/environment, user action, expected and observed result, command/exit code, and evidence links. Screenshots or traces should show both the action and the discriminating result. Include task/run/request IDs when relevant, without secrets.
A fix is verified across its affected surfaces only when each has evidence or an explicit reason it does not apply. Shared code alone does not prove parity. Keep product regressions visible; do not change the recipe to bless a failure. For Paperclip-assigned work, attach evidence through the artifact workflow.
Inventory and remaining depth
The UI coverage inventory accounts for every non-test TSX
module under ui/src/pages, including supporting panels, legacy variants, and
labs. Every product area now links to concrete recipes. Partial means the
area still has the named variant or workflow gaps; unmapped is reserved for
an area with no recipe. These statuses describe documentation, not runtime health.
The page inventory is a source snapshot dated 2026-10-05. The map also includes entry points hosted inside other modules (pipeline Review Queue and Learnings, task documents, onboarding), CLI-only operations, and operator work. The team recipe explicitly distinguishes the current CLI/API path from catalog UI components without a current top-level route. Refer to route registration and the CLI registry when changing reachability.
Remaining depth includes complete provider/auth/attachment matrices, every harness/model/environment capability combination, third-party plugin features, and every role/error/mobile/legacy-shell permutation. The recipes name relevant gaps instead of equating source presence with a working user journey. The index can include capabilities that do not add a page file.
Maintaining the reference
The map documents user journeys. It does not execute them automatically;
coverage.json records documentation scope rather than live test health.
When maintaining a recipe, compare its entry points and expected results with
the current source. Check that linked tests still exercise the stated behavior
and that local references still exist. Refresh the inventory snapshot when it
helps explain the current product. Keep the same-named agent access companion
and stable sub-feature IDs aligned when behavior or access changes. Source-only
access inventory remains distinct from live verification. Run
node scripts/check-maps.mjs after map edits for structural/reference checks;
follow the shared contract for the source and behavioral checks it cannot perform.
Each recipe starts with an H1 and a user-visible description, then exactly:
- Sub-features — stable backticked IDs and observable behavior/states.
- How to get to it (user POV) — one H3 backticked entry-point ID per surface.
- Driving it with — starts with
Preconditions:; repeat each entry-point H3, withAutomated:andManual:paragraphs. Name test scope and gaps honestly. - Gotchas — misleading look-alikes, feature gates, and invalid evidence.
New or updated entries follow
Poteto's feature-map examples.
Existing entries with a Driving it heading can adopt the named harness when
their recipes are updated. The original format was inspired by
Omnigent's feature map.
Paperclip's recipes and checks follow its own task model and test infrastructure.