mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 21:05:21 +02:00
DottaandPaperclip
33f2b3a159
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The Connectors catalog lets people give agents tools or connect agents to conversations. > - GitHub put these two uses behind one card and an extra choice. > - People should choose the connection they need from the catalog. > - This pull request keeps GitHub for tools and adds GitHub Code Review Bot as a separate card. > - Each card opens its setup directly. Both use the existing connection code. ## Linked Issues or Issue Description **What existing behavior does this improve?** GitHub connector discovery and setup. **Current behavior** With chat connectors enabled, GitHub opens a menu that asks whether to use tools or create a bot. Saved tools and bots share the same catalog entry. **Proposed behavior** GitHub opens tool account access. GitHub Code Review Bot opens agent selection. Saved bots and drafts appear under the bot card. Chat-disabled instances show only GitHub tools. **Reason and benefit** The catalog names the two uses and removes an extra setup choice. The bot keeps the existing GitHub provider, credentials, endpoint IDs, setup steps, and runtime. **Additional context** Related work: https://github.com/paperclipai/paperclip/pull/12843 and https://github.com/paperclipai/paperclip/pull/14594 established GitHub account identity. This change preserves that tool flow. No duplicate catalog split was found. ## What Changed - Split the generated app definitions into GitHub tools and GitHub Code Review Bot. Reuse the existing GitHub logo and channel method. - Open bot setup directly, including old resume and reconnect links. - Put existing bot endpoints and drafts under the bot card. Hide duplicate internal chat applications. - Keep pasted GitHub URLs mapped to the tool connection. - Add seven Storybook states for the catalog, saved connections, disabled chat, both setup paths, mobile, and light mode. - Fix narrow-screen bot rows so the label cannot overlap status and setup actions. - Update catalog, route, browser, and API tests, plus the GitHub connector guide. ## Verification - [Hosted Storybook](https://d1p6rlowie26tp.cloudfront.net/storybook/branches/codex~2Fgithub-review-connection/?path=/story/connections-github-and-code-review-bot--catalog): seven states built from this branch. The deployment passed its public-file verification. - All GitHub checks pass on `d13a2cd53561645bb2a15c6f8e75a61a936d6459`. Two optional Storybook jobs skip under their normal trigger rules; the manual Storybook deployment passes. The branch has no merge conflicts. - Greptile: 5/5 on the current head, with no review comments or unresolved threads. - `pnpm -r typecheck`, `pnpm build`, `pnpm check:token-gates`, and `pnpm build-storybook` passed. The final Storybook fixture also passed UI typecheck and the hosted build. - Targeted catalog, URL matching, routing, grouping, brand, and chat UI contract tests passed. - GitHub provider browser tests: 2 passed. These cover direct tool setup and the bot setup and management lifecycle with provider responses mocked. - Embedded-browser test on an isolated local instance: opened both cards, selected an agent, saved a bot draft, and resumed the same endpoint under the bot card after a reload. - Storybook Tool Setup and Bot Setup assertions pass in the published preview. Chat Disabled assertions pass locally. Inspected mobile and light mode, including the draft-row layout and official GitHub marks. - Local full-suite limitation: `pnpm test:run` was not clean. A cross-company route assertion failed in the aggregate run and passed in isolation; a workspace-runtime test reached its 30-second hook timeout. Some isolated database reruns skipped when the embedded-PostgreSQL availability probe failed. The local aggregate was stopped after CI completed. The corresponding full CI suites pass all 360 tool-access tests and all 162 workspace-runtime tests. - No live GitHub authorization or installation was performed. The isolated instance correctly stopped at the cloud enrollment or public HTTPS prerequisites. ## Risks - Low scope: catalog presentation and routing change. There is no database migration or provider credential change. - Existing GitHub bot URLs now open bot setup directly. The tool route remains `/apps/connect?source=github`. - The bot remains behind the existing chat-connectors feature flag. Existing endpoints retain `provider: github`. - Channel applications are represented by endpoint rows. Regression tests cover legacy bot applications, tools, active bots, and drafts together. ## Model Used OpenAI GPT-6 through Codex, with reasoning, code execution, and embedded-browser tools. The exact deployed model ID, context window size, and reasoning setting are not exposed to this session. ## 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>
86 lines
2.6 KiB
JSON
86 lines
2.6 KiB
JSON
{
|
||
"schemaVersion": 1,
|
||
"slug": "github",
|
||
"name": "GitHub",
|
||
"description": "Give agents access to GitHub repositories, issues, and pull requests.",
|
||
"categories": [
|
||
"developer"
|
||
],
|
||
"featured": true,
|
||
"branding": {
|
||
"logoUrl": "/brands/apps/github.svg",
|
||
"darkLogoUrl": "/brands/apps/github-dark.svg"
|
||
},
|
||
"urlPatterns": [
|
||
"https://api.githubcopilot.com/mcp/*",
|
||
"https://github.com/*"
|
||
],
|
||
"methods": [
|
||
{
|
||
"key": "managed",
|
||
"transport": "mcp_remote",
|
||
"auth": "oauth",
|
||
"ownershipModes": [
|
||
"platform_shared"
|
||
],
|
||
"whenToUse": "Connect your GitHub account for durable MCP, shell Git, gh, and repository access.",
|
||
"defaults": {
|
||
"serverUrl": "https://api.githubcopilot.com/mcp/"
|
||
},
|
||
"guidanceMd": "Authorize Paperclip, then choose selected repositories in GitHub. You can edit repository access later from GitHub's installation settings.",
|
||
"riskTier": "S3",
|
||
"label": "Connect GitHub",
|
||
"purpose": "tool",
|
||
"oauthStrategy": "paperclip_cloud_connector",
|
||
"connectorProfile": "github.code",
|
||
"grantKinds": [
|
||
"user",
|
||
"agent"
|
||
],
|
||
"warnings": [
|
||
"Shell Git and gh receive this identity for the run and are not constrained by per-tool Ask-first controls."
|
||
],
|
||
"requiredResourceFilters": [
|
||
"organization",
|
||
"repository"
|
||
]
|
||
},
|
||
{
|
||
"key": "mcp-key",
|
||
"transport": "mcp_remote",
|
||
"auth": "api_key",
|
||
"ownershipModes": [
|
||
"customer"
|
||
],
|
||
"whenToUse": "Use the provider-hosted connection for the quickest setup.",
|
||
"defaults": {
|
||
"serverUrl": "https://api.githubcopilot.com/mcp/"
|
||
},
|
||
"guidanceMd": "Create a fine-grained token limited to the repositories agents should use.",
|
||
"riskTier": "S3",
|
||
"label": "Personal access token (advanced)",
|
||
"purpose": "tool",
|
||
"credentialFields": [
|
||
{
|
||
"key": "authorization",
|
||
"label": "GitHub token",
|
||
"type": "password",
|
||
"required": true,
|
||
"placeholder": "github_pat_...",
|
||
"secret": true,
|
||
"helperMd": "Repository contents, issues, pull requests and other granted toolsets; selected repos and installation/PAT permissions apply. Create a key with read and write permissions for these actions; Paperclip cannot increase an existing key’s permissions."
|
||
}
|
||
],
|
||
"keyPlacement": {
|
||
"location": "header",
|
||
"name": "Authorization",
|
||
"prefix": "Bearer "
|
||
},
|
||
"requiredResourceFilters": [
|
||
"organization",
|
||
"repository"
|
||
]
|
||
}
|
||
]
|
||
}
|