paperclip/doc/plans
Dotta 2dbaf4a7fa
External object references across issue surfaces (#8512)
## Thinking Path

> - Paperclip is the open source control plane people use to coordinate
AI agents, issues, approvals, comments, and work products.
> - The involved subsystem is issue context: markdown links, issue
properties, related work, lists, filters, inbox/sidebar status, and
plugin-provided external context.
> - The gap is that URLs to external systems currently remain mostly
plain links, so humans and agents must manually open them to understand
status, identity, and liveness.
> - This matters because external work objects such as GitHub issues and
pull requests are part of the operational state of a Paperclip company.
> - The implementation keeps core provider-neutral: shared contracts,
storage, sync, routes, and UI surfaces live in core while providers can
contribute detection and status resolution.
> - This pull request adds the external object reference foundation,
GitHub provider support, issue-surface rendering, filters,
sidebar/list/inbox signals, and test/story coverage.
> - The benefit is that linked external work becomes inspectable
Paperclip context without hardcoding every provider directly into the
UI.

## Linked Issues or Issue Description

No public GitHub issue exists for this work.

Feature request:

- Problem: URLs in Paperclip issues, comments, documents, and related
surfaces do not expose provider status or object identity inline.
- Proposed behavior: detect supported external object URLs, persist
normalized references, refresh provider status, and render concise
status-aware links across issue surfaces.
- Users affected: board users, agents, and maintainers who triage issues
containing external work links.
- Acceptance: external object references are company-scoped,
provider-extensible, visible in key issue surfaces, filterable where
relevant, and covered by focused shared/server/UI tests.

Related PR search:

- No open duplicate PRs found for `external object references`.
- Closed related prior attempt: #4556.

## What Changed

- Added shared external-object contracts, validators, status/liveness
helpers, and plugin protocol declarations.
- Added database schema and additive migrations for external objects,
source mentions, and display metadata.
- Added server services/routes for detecting, syncing, summarizing,
refreshing, and resolving external objects across issues, documents,
comments, projects, and plugins.
- Added a GitHub external-object provider plus plugin SDK authoring
docs.
- Wired UI presentation across markdown links, comments, issue chat,
documents, properties, related work, issue rows, filters, inbox/sidebar
badges, and Storybook stories.
- Rebasing cleanup: moved the branch onto current `master`, repaired
stale worktree provision config, hardened environment-sensitive
tests/mocks, and removed committed screenshot artifacts from the PR
branch to keep the reviewable file set below tool limits.

## Verification

- `pnpm exec vitest run packages/shared/src/external-objects.test.ts
server/src/__tests__/external-object-routes.test.ts
server/src/__tests__/external-objects-service.test.ts
ui/src/components/ExternalObjectPill.test.tsx
ui/src/lib/external-objects.test.ts` passed after rebasing: 5 files, 56
tests.
- Historical branch verification before this PR creation included `pnpm
test:run`, `pnpm -r typecheck`, and `pnpm build`; this PR body does not
claim those were rerun after the final rebase.

## Risks

- Medium: this adds a new cross-surface sync path on
issue/document/comment writes. The implementation uses safe sync
wrappers so external-object failures warn instead of blocking core
mutations.
- Medium: the migrations introduce new tables and indexes. They are
additive and company-scoped.
- Medium: provider-specific URL parsing can miss or misclassify edge
cases. Shared canonicalization tests and provider tests cover current
GitHub shapes.
- Low: UI badge/filter behavior could add visual noise for object-heavy
issues; component tests and Storybook stories cover the intended
surfaces.

> Roadmap checked: `ROADMAP.md` references the plugin system as the
current extension path and does not list a duplicate core feature.
Related long-range docs discuss external references, work products,
preview URLs, and plugin extension points; this PR implements the scoped
external-object reference foundation.

## Model Used

OpenAI Codex, GPT-5 coding-agent runtime, with shell and GitHub CLI tool
use. Reasoning mode: medium. Exact deployed runtime model ID and context
window were not exposed in the environment.

## 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-06-23 08:27:19 -05:00
..
2026-02-16-module-system.md
2026-02-18-agent-authentication-implementation.md
2026-02-18-agent-authentication.md
2026-02-19-agent-mgmt-followup-plan.md
2026-02-19-ceo-agent-creation-and-hiring.md
2026-02-20-issue-run-orchestration-plan.md
2026-02-20-storage-system-implementation.md
2026-02-21-humans-and-permissions-implementation.md
2026-02-21-humans-and-permissions.md
2026-02-23-cursor-cloud-adapter.md
2026-02-23-deployment-auth-mode-consolidation.md
2026-03-10-workspace-strategy-and-git-worktrees.md
2026-03-11-agent-chat-ui-and-issue-backed-conversations.md
2026-03-13-TOKEN-OPTIMIZATION-PLAN.md
2026-03-13-agent-evals-framework.md
2026-03-13-company-import-export-v2.md
2026-03-13-features.md
2026-03-13-paperclip-skill-tightening-plan.md
2026-03-13-plugin-kitchen-sink-example.md
2026-03-13-workspace-product-model-and-work-product.md
2026-03-14-adapter-skill-sync-rollout.md
2026-03-14-billing-ledger-and-reporting.md
2026-03-14-budget-policies-and-enforcement.md
2026-03-14-skills-ui-product-plan.md
2026-03-17-docker-release-browser-e2e.md
2026-03-17-memory-service-surface-api.md
2026-03-17-release-automation-and-versioning.md
2026-04-06-smart-model-routing.md
2026-04-06-subissue-creation-on-issue-detail.md
2026-04-07-issue-detail-speed-and-optimistic-inventory.md
2026-04-07-pi-hooks-survey.md
2026-04-08-agent-browser-process-cleanup-plan.md
2026-04-08-agent-os-follow-up-plan.md
2026-04-08-agent-os-technical-report.md
2026-04-12-vscode-task-interoperability-plan.md
2026-04-24-external-object-reference-backfill.md
2026-04-26-plugin-secret-ref-company-scope.md
2026-05-05-scaled-kanban-board-design.md
2026-05-05-scaled-kanban-board.md
2026-05-06-llm-wiki-paperclip-asset-security-gate.md
2026-05-23-cli-api-parity-openapi-reference.ts
2026-05-23-cli-api-parity.md
2026-05-26-skills-cli-catalog-contract.md
2026-06-03-low-trust-review-contract.md
workspace-product-model-and-work-product.md
workspace-technical-implementation.md