Files
PaperClipAI/doc/connections/github-copilot.md
T
DottaandClaude Opus 5.5 53fedd653b fix(connections): split GitHub Copilot into its own connector (#22238)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - The Connectors catalog lets people give agents tools and AI
accounts.
> - GitHub showed repository access and GitHub Copilot authentication on
one card.
> - The card had an extra "Connect Copilot" button. Saved Copilot
accounts showed in the GitHub account list.
> - These are two different products. People must find each one by its
own name.
> - This pull request makes GitHub Copilot a separate connector. GitHub
keeps repository and MCP access only.
> - The benefit is a clear catalog. Each card opens its own setup, and
saved accounts show on the correct card.

## Linked Issues or Issue Description

**What existing behavior does this improve?**

Discovery and setup of the GitHub and GitHub Copilot connectors.

**Current behavior**

The GitHub card says "Connect GitHub repository access or authenticate
GitHub Copilot agents." It shows a "Connect Copilot" button next to its
own Connect button. Saved Copilot accounts show in the GitHub account
list. Agent connection search returns Copilot as a method of GitHub. The
Copilot setup link that search gives to agents opens the GitHub tool
setup.

**Proposed behavior**

GitHub and GitHub Copilot are two cards. GitHub says "Give agents access
to GitHub repositories, issues, and pull requests." GitHub Copilot has
its own logo and opens Copilot token setup. Saved Copilot accounts,
including accounts saved before this change, show on the GitHub Copilot
card.

**Reason and benefit**

People do not have to know that Copilot is behind the GitHub card. The
catalog names the two products. The Copilot runtime keeps the same
provider identity, token storage, grants, and model discovery.

**Additional context**

This follows the same pattern as the GitHub Code Review Bot split in
#14750. Copilot setup was added in #15705.

## What Changed

- Add a `github-copilot` app definition with the existing
`copilot-token` method. Remove that method from `github`. Restore the
GitHub description and the `developer` category.
- Add the GitHub Octicons Copilot mark (MIT license, from
`primer/octicons`) as light and dark brand assets.
- Map the `github` AI provider to the `github-copilot` catalog entry in
`aiConnectionCatalogSlug`. New Copilot accounts save under a "GitHub
Copilot" application.
- Remove the "Connect Copilot" button from the GitHub card.
- Show saved AI accounts on the card for their provider. This includes
Copilot accounts that were saved under the GitHub application. The
connection page and its reconnect link use the same rule.
- Redirect old `/apps/connect?source=github&method=copilot-token` links
to `source=github-copilot`. Keep the other query values.
- Keep the "My GitHub account" identity wording on the Copilot access
step.
- In connection search and connection requests, file AI accounts under
their catalog entry. Accept the `github` provider for the
`github-copilot` service. Copilot authentication recovery cards now open
GitHub Copilot setup, not GitHub tool setup.
- Keep older Copilot accounts and requests working. An older account
saved under the GitHub application reconnects through GitHub Copilot,
and an older Copilot draft resumes through GitHub Copilot. A recovery
request saved with the `github` service name can complete. A Copilot
request declined before this change stays declined in its continuation.
Adoption accepts the `github` provider binding for a `github-copilot`
request.
- Move the rule that finds an AI account's catalog entry
(`aiConnectionSourceSlug`) into `@paperclipai/shared`, so the UI and
server use one copy.
- Use the Copilot logo for Copilot in the AI account picker and account
details.
- Update the GitHub Copilot connection doc and the GitHub connections
Storybook story. The GitHub and GitHub Copilot setup stories open
**Change** before checking "Connect GitHub as", because that heading
sits in the collapsed access section.

## Verification

- New and updated tests fail on `master` and pass with this change:
  - `pnpm exec vitest run packages/shared/src/app-definitions.test.ts`
- `pnpm exec vitest run ui/src/pages/apps/Browse.test.tsx
ui/src/pages/apps/AppsConnect.test.tsx
ui/src/pages/apps/AppDetail.test.tsx
ui/src/pages/apps/app-connect-policy.test.ts
ui/src/pages/apps/Connections.test.tsx`
- `pnpm exec vitest run
server/src/__tests__/connection-intents-service.test.ts
server/src/__tests__/ai-connections.test.ts`
- `pnpm exec vitest run
ui/src/features/connections/ConnectionSetupFlow.oauth.test.ts`
- Older-account tests cover reconnect, draft resume, completion of a
request saved with `github`, a request declined before the split, and
Copilot adoption. Each test fails without its fix.
- The play functions of all 8 stories in
`github-connections.stories.tsx` pass when rendered with
`composeStories` in jsdom.
- Brand checks: `node scripts/check-app-brand-assets.mjs`,
`ui/src/lib/app-brand-assets.test.ts`, and
`ui/src/pages/apps/AppLogo.brand-assets.test.tsx`.
- Typecheck: `@paperclipai/shared`, `@paperclipai/ui`, and
`@paperclipai/server`.
- Manual check in `pnpm dev:once` with a local company:
1. Open Connectors and search for "GitHub". Two cards show: "GitHub" and
"GitHub Copilot". GitHub has no "Connect Copilot" button.
2. Seed one GitHub tool account and one Copilot account under the GitHub
application, as older installs have them. The GitHub tool account shows
on GitHub. The Copilot account shows on GitHub Copilot.
3. Click Connect on GitHub Copilot. The "Connect GitHub Copilot" page
opens with the Copilot logo and the token field.
4. Open `/apps/connect?source=github&method=copilot-token`. The page
redirects to `source=github-copilot`.
  5. Open GitHub setup. It offers repository access only.
  6. Check the catalog in light and dark themes.

## Risks

- Low risk. There is no database migration. Existing Copilot accounts
keep their application and stored source. The UI and connection search
group them by their AI provider.
- New Copilot accounts save under a new "GitHub Copilot" application and
record `github-copilot` as their source. Code that finds GitHub
repository identities by `sourceTemplateKey === "github"` no longer sees
new Copilot accounts. These are AI accounts, so this is the intended
separation.
- A pending Copilot recovery card from before this change keeps the
`github` service slug. The server still resolves it to GitHub Copilot,
and the card can complete.
- Search for "github" now returns two results: GitHub and GitHub
Copilot.

## Model Used

- Claude Opus 5.5 (`claude-opus-5-5`) through Claude Code, with tool use
(shell, file edits, test runs, and a headless browser for the manual
check).

## 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

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 08:51:36 -06:00

77 lines
4.9 KiB
Markdown

# GitHub Copilot runtime connection
GitHub Copilot uses a saved GitHub token and the packaged Copilot CLI **1.0.88**.
Runtime profile **v47** passed the local and Daytona qualification campaign.
The [qualification record](../plans/2026-10-20-copilot-qualification-v47.json)
identifies the tested build, retained failures, and remaining release gates.
On first setup, choose **GitHub Copilot** when creating your first agent. In an
existing organization, open **Connectors → GitHub Copilot → Connect**. GitHub
Copilot is its own connector, separate from the **GitHub** connector for
repository and MCP access. Create a fine-grained personal access token owned
by your personal GitHub account and add the **Copilot Requests** account
permission. Organization-owned tokens and classic personal tokens are
unsupported for this setup. Follow
[GitHub's authentication instructions](https://docs.github.com/en/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli).
Save the token as a personal or shared AI connection and select the execution
environment. Copilot accounts saved before the split are listed under GitHub
Copilot as well, and older `source=github&method=copilot-token` setup links
redirect there. Paperclip uses its encrypted credential store, grants, access
checks, reconnect/revocation, and activity logging. GitHub repository/MCP access
uses its separate connection and grants. Copilot execution receives only the
selected runtime token as `COPILOT_GITHUB_TOKEN`; ambient GitHub credentials
are not adopted.
Connection verification runs the pinned packaged runtime in the selected
environment with a private temporary home. It initializes a session, discovers
models, and confirms an explicitly selected model when testing an agent. It
sends no model prompt. Authentication, entitlement/policy, installation, and
unavailable-model errors are reported separately. Remote verification releases
its owned login lease and does not fall back to the controller host.
In an agent's **Harness / Runtime** settings, select **Paperclip Runner**,
**ACP agents**, **GitHub Copilot**, and a model from authenticated discovery.
Saving and reopening retain `provider: acpx`, `acpxAgent: copilot`, and that exact
model. Auto/default and unavailable models are rejected. The qualification
model is `gpt-5.6-luna`, subject to current authenticated availability. Reconnecting
the same saved account refreshes its discovered models and clears the old selection.
Normal package installation materializes the pinned runtime for macOS ARM64,
macOS x64, and Linux x64. Keep installation scripts enabled. No qualification
environment override or ambient GitHub login is required. **Test configuration**
verifies the saved connection and exact model without sending a prompt.
For Daytona, install the first-party Daytona provider and configure an execution
environment with its saved API key and the matching release image. Environment
assignment currently uses Paperclip's existing **Enable Environments** instance
setting. Select that environment for connection verification and agent execution;
successful local verification alone does not establish remote readiness. The
admitted daemon and provider assets must belong to the same verified build.
Core workflows use Paperclip's semantic questions, plans, and completion tools.
Permission cards identify actual targets. Denied writes have no effects; Stop
cancels unanswered permissions and refuses late answers. Provider death must
expire stale input without replay. Detached work, native steering, native plan
mode, and additional native event presentation are outside this release.
Unsupported native blocking callbacks fail explicitly.
Usage is attributed to **GitHub**. Provider credits and model multipliers are
supplemental notices, not USD billing receipts. USD cost remains unknown when
GitHub supplies no invoice value; included credits are not recorded as measured
zero-dollar usage. Session-scoped notices cannot establish task completion,
artifacts, or charges.
Model discovery uses the selected environment and can create a short-lived Daytona sandbox. Copilot model choices refresh when opening a task selector, changing an account or environment, reconnecting, or explicitly refreshing. Background live-data reconciliation does not repeat this probe.
The qualification record retains one Daytona tool-dispatch timeout whose exact
cause is unresolved. Its unchanged instrumented recheck passed after independent
ordinary remote delivery and the other19 Product cases passed. No timeout or
completion check was weakened. Qualification does not establish deployment: use
the release record to verify the shipped package and canary.
Discovering models for an existing agent requires permission to update that
agent configuration. The probe uses the saved environment unless an authorized
editor selects another environment. Read-only configuration access does not
resolve the token or start a discovery probe.