@capybara-hq/plugin-github 0.0.0-stage → 0.1.0-rc.1

package/.capybara-plugin/plugin.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://capybarahq.com/schemas/plugin.v1.schema.json",
+  "schemaVersion": 1,
+  "name": "github",
+  "version": "0.1.0-rc.1",
+  "publisher": "Capybara",
+  "description": {
+    "en": "Agents work with GitHub as the connected person: issues, pull requests, reviews, repositories and Actions runs, through GitHub's remote MCP server. Each member connects with OAuth through a GitHub App (or OAuth App) the org admin registers",
+    "zh": "智能体以连接者本人的身份使用 GitHub：issue、拉取请求、评审、仓库与 Actions 运行，经 GitHub 的远程 MCP 服务器。每位成员通过组织管理员注册的 GitHub App（或 OAuth App）用 OAuth 连接"
+  },
+  "displayName": {
+    "zh": "GitHub",
+    "en": "GitHub"
+  },
+  "icon": "./icon.svg",
+  "homepage": "https://github.com/capybara-hq/plugins/tree/main/plugins/github#readme",
+  "dependencies": [
+    {
+      "name": "connector-mcp",
+      "version": "^0.1.0-rc.1"
+    }
+  ],
+  "connectorTemplates": [
+    {
+      "path": "./connectors/github.json"
+    }
+  ],
+  "setupGuides": [
+    {
+      "id": "github-oauth",
+      "place": "connector-template",
+      "template": "github"
+    }
+  ]
+}

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+Capybara
+Copyright 2026 Meta-1 (Tianjin Yuanyilian Technology Co., Ltd.)

package/README.md

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+# @capybara-hq/plugin-github
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The GitHub connector template (declarative: no extension). Agents work with GitHub **as the
+person using them**: issues, pull requests, comments and reviews, repository files and branches,
+and Actions runs and logs, through [GitHub's remote MCP server](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md)
+(`https://api.githubcopilot.com/mcp/`) on the [`connector-mcp`](../connector-mcp) connector.
+
+| Template | Auth | Default |
+|---|---|---|
+| `github` | Per-person OAuth (`oauth_code`, MCP discovery, manual client): the org admin registers a GitHub App (recommended: fine-grained permissions, per-installation repositories, tokens that expire after eight hours and are refreshed) or an OAuth App (classic scopes `repo`, `read:org`, `read:user`, `user:email`, `workflow`) | on |
+
+GitHub does not support dynamic client registration, so the OAuth template always needs a client
+the org admin enters.
+
+## Tools and policies
+
+The template sets the endpoint header `X-MCP-Toolsets: context,repos,issues,pull_requests,users,actions`
+(GitHub's default toolsets plus `actions` for CI status). The header and the URL are editable per
+org (`editableEndpoint`): add toolsets, set `X-MCP-Readonly: true`, or point the URL at a GitHub
+Enterprise Cloud data residency host (`https://copilot-api.<subdomain>.ghe.com/mcp`). GitHub
+Enterprise Server has no remote MCP server.
+
+`defaultToolPolicies` lists every tool of those toolsets in github/github-mcp-server (checked
+2026-11-12, including the tools behind GitHub's feature flags): the read-only tools are `allow`,
+every write is `ask` (creating issues and pull requests, comments, reviews, merging, pushing files,
+branches, re-running workflows), and `delete_repository` is `deny`. GitHub's tool names use only
+`[a-z0-9_]`, so every tool key is valid. A tool GitHub adds later gets the kernel's default from its
+annotation (read-only: allow, else ask) and goes through the drift review.
+
+## Setup guides
+
+`guides/github-oauth.md` (template `github`: GitHub App settings, the OAuth App alternative, the
+kernel checks `public-url`, `oauth-client`, `oauth-token-endpoint`, `connector-tools`, and how a
+member connects and revokes), with a Chinese version. Preview with
+`capybara-plugin guide github-oauth --audience admin` from this directory.
+
+## Tests
+
+```bash
+pnpm exec vitest run plugins/github
+# live, against GitHub (lists the tools and calls get_me; read-only):
+CAPYBARA_TEST_LIVE_TOOLS=1 pnpm exec vitest run plugins/github/test/live -t live
+```
+
+The live test needs `CAPYBARA_TEST_GITHUB_MCP_TOKEN`: a personal access token stands in for a
+member's OAuth token, since the OAuth flow needs a browser. Keep it in an env file outside the
+repository.
+
+A personal access token template was dropped before release: OAuth through a GitHub App gives
+expiring tokens, per-installation repositories and admin control, which a member-made token does not.

package/connectors/github.json

@@ -0,0 +1,122 @@
+{
+  "displayName": {
+    "zh": "GitHub",
+    "en": "GitHub"
+  },
+  "description": "Issues, pull requests, reviews, repositories and Actions runs as the connected person, through GitHub's remote MCP server. Each member connects their own GitHub account with OAuth; an org admin registers a GitHub App (recommended) or OAuth App and enters its client here.",
+  "icon": "./icon.svg",
+  "template": {
+    "plugin": "connector-mcp",
+    "pluginVersion": "^0.1.0-rc.1",
+    "connector": "mcp",
+    "endpoint": {
+      "url": "https://api.githubcopilot.com/mcp/",
+      "headers": {
+        "X-MCP-Toolsets": "context,repos,issues,pull_requests,users,actions"
+      }
+    },
+    "editableEndpoint": ["url", "headers"],
+    "auth": {
+      "type": "oauth_code",
+      "ownership": "personal",
+      "discovery": "mcp",
+      "client": "manual",
+      "tokenAuthMethod": "client_secret_post",
+      "scopes": ["repo", "read:org", "read:user", "user:email", "workflow"]
+    },
+    "defaultToolPolicies": {
+      "get_me": "allow",
+      "get_teams": "allow",
+      "get_team_members": "allow",
+      "ui_get": "allow",
+      "get_commit": "allow",
+      "get_file_contents": "allow",
+      "get_file_blame": "allow",
+      "get_latest_release": "allow",
+      "get_release_by_tag": "allow",
+      "get_tag": "allow",
+      "list_branches": "allow",
+      "list_commits": "allow",
+      "list_releases": "allow",
+      "list_repository_collaborators": "allow",
+      "list_tags": "allow",
+      "search_code": "allow",
+      "search_commits": "allow",
+      "search_repositories": "allow",
+      "issue_read": "allow",
+      "list_issues": "allow",
+      "search_issues": "allow",
+      "list_issue_types": "allow",
+      "list_issue_fields": "allow",
+      "get_label": "allow",
+      "find_duplicate": "allow",
+      "issue_dependency_read": "allow",
+      "issue_artifact_read": "allow",
+      "pull_request_read": "allow",
+      "list_pull_requests": "allow",
+      "search_pull_requests": "allow",
+      "search_users": "allow",
+      "actions_get": "allow",
+      "actions_list": "allow",
+      "get_job_logs": "allow",
+      "create_branch": "ask",
+      "create_or_update_file": "ask",
+      "push_files": "ask",
+      "delete_file": "ask",
+      "create_repository": "ask",
+      "fork_repository": "ask",
+      "create_issue": "ask",
+      "issue_write": "ask",
+      "add_issue_comment": "ask",
+      "update_issue_comment": "ask",
+      "sub_issue_write": "ask",
+      "add_sub_issue": "ask",
+      "remove_sub_issue": "ask",
+      "reprioritize_sub_issue": "ask",
+      "set_issue_fields": "ask",
+      "update_issue_assignees": "ask",
+      "update_issue_body": "ask",
+      "update_issue_labels": "ask",
+      "update_issue_milestone": "ask",
+      "update_issue_state": "ask",
+      "update_issue_title": "ask",
+      "update_issue_type": "ask",
+      "issue_dependency_write": "ask",
+      "issue_artifact_write": "ask",
+      "add_issue_reaction": "ask",
+      "add_issue_comment_reaction": "ask",
+      "remove_issue_reaction": "ask",
+      "remove_issue_comment_reaction": "ask",
+      "hide_issue_comment": "ask",
+      "unhide_issue_comment": "ask",
+      "create_pull_request": "ask",
+      "update_pull_request": "ask",
+      "update_pull_request_branch": "ask",
+      "update_pull_request_body": "ask",
+      "update_pull_request_title": "ask",
+      "update_pull_request_state": "ask",
+      "update_pull_request_draft_state": "ask",
+      "merge_pull_request": "ask",
+      "request_pull_request_reviewers": "ask",
+      "pull_request_review_write": "ask",
+      "create_pull_request_review": "ask",
+      "submit_pending_pull_request_review": "ask",
+      "delete_pending_pull_request_review": "ask",
+      "add_comment_to_pending_review": "ask",
+      "add_pull_request_review_comment": "ask",
+      "add_reply_to_pull_request_comment": "ask",
+      "resolve_review_thread": "ask",
+      "unresolve_review_thread": "ask",
+      "add_pull_request_review_comment_reaction": "ask",
+      "remove_pull_request_review_comment_reaction": "ask",
+      "hide_pull_request_review": "ask",
+      "unhide_pull_request_review": "ask",
+      "hide_pull_request_review_comment": "ask",
+      "unhide_pull_request_review_comment": "ask",
+      "assign_copilot_to_issue": "ask",
+      "request_copilot_review": "ask",
+      "actions_run_trigger": "ask",
+      "delete_repository": "deny"
+    }
+  }
+}

package/guides/github-oauth.md

@@ -0,0 +1,93 @@
+# Set up the GitHub connector
+
+The GitHub connector lets agents read and work on issues, pull requests, reviews, repository
+files and Actions runs **as the person using them**, through GitHub's remote MCP server. Each
+member connects their own GitHub account, so an agent sees and changes only what that person can,
+and GitHub's audit log names that person.
+
+::: audience admin
+An org admin sets it up once: register an app on GitHub, then enter its client id and secret here.
+Members connect afterwards.
+
+## 1. Register a GitHub App (recommended)
+
+A GitHub App gives members tokens limited to the permissions below and to the repositories the
+app is installed on, and the tokens expire after eight hours (Capybara refreshes them).
+
+Open **Settings → Developer settings → GitHub Apps → New GitHub App** of the GitHub organization
+that owns your repositories (`https://github.com/organizations/<org>/settings/apps/new`) and fill
+in the form as listed below. Leave everything not listed at its default.
+
+```yaml title="GitHub App settings (GitHub connector)"
+# GitHub App for the "{{templateName}}" connector template ({{pluginName}} {{pluginVersion}}).
+# Reference: https://docs.github.com/apps/creating-github-apps (checked 2026-11-12).
+GitHub App name: "Capybara connector"
+Homepage URL: "{{publicUrl}}"
+Callback URL: "{{oauthCallbackUrl}}"
+Expire user authorization tokens: on
+Request user authorization (OAuth) during installation: off
+Enable Device Flow: off
+Webhook Active: off
+Repository permissions:
+  Actions: Read and write        # read runs and logs, re-run workflows
+  Checks: Read-only
+  Commit statuses: Read-only
+  Contents: Read and write       # files, branches, commits, merges
+  Issues: Read and write
+  Metadata: Read-only            # mandatory
+  Pull requests: Read and write
+  Workflows: Read and write      # change files under .github/workflows
+Organization permissions:
+  Members: Read-only             # teams
+Account permissions:
+  Email addresses: Read-only
+Where can this GitHub App be installed: Only on this account
+```
+
+::check capybara:public-url The platform has a public URL
+
+Then **Install App** on the organization, for all repositories or the ones agents may touch. A
+member's token never reaches further than both the member's own access and this installation.
+
+### An OAuth App instead
+
+An OAuth App (**Settings → Developer settings → OAuth Apps → New OAuth App**, authorization
+callback URL `{{oauthCallbackUrl}}`) also works. Its tokens do not expire and carry the classic
+scopes this template asks for (`repo`, `read:org`, `read:user`, `user:email`, `workflow`) across
+every repository the member can reach. If the organization restricts OAuth App access, an owner
+approves the app under **Settings → Third-party access**.
+
+## 2. Enter the client
+
+Copy the app's **Client ID**, generate a **client secret**, and enter both in the fields below. The
+secret is stored encrypted and reads back only as "set".
+
+::check capybara:oauth-client The client id and secret are entered
+::check capybara:oauth-token-endpoint GitHub accepts the client id and secret
+::check capybara:connector-tools A member connected and the tool list was read
+
+## Tools and approvals
+
+The template turns on GitHub's `context`, `repos`, `issues`, `pull_requests`, `users` and
+`actions` toolsets (the endpoint header `X-MCP-Toolsets`; edit it to add or remove toolsets).
+Reads run directly. Writes (creating issues and pull requests, comments and reviews, merging,
+pushing files, creating branches, re-running workflows) ask the member first, and deleting a
+repository is denied. Change any of these per tool on the connector page.
+
+For GitHub Enterprise Cloud with data residency, change the endpoint URL to
+`https://copilot-api.<your-subdomain>.ghe.com/mcp` and register the app on that host.
+:::
+
+::: audience member
+## Connect your GitHub account
+
+Choose **Connect** and approve on GitHub's consent screen. Agents then act on GitHub as you, and
+writes ask you first unless your admin changed that. An agent sees only the repositories you can
+see and, with a GitHub App, only those the app is installed on.
+
+**Disconnect** deletes the token in Capybara. To revoke it at GitHub too, open
+**Settings → Applications → Authorized GitHub Apps** (or **Authorized OAuth Apps**) and revoke
+the app.
+
+::check capybara:connector-connected Your GitHub account is connected
+:::

package/guides/github-oauth.zh.md

@@ -0,0 +1,84 @@
+# 设置 GitHub 连接器
+
+GitHub 连接器让智能体**以使用者本人的身份**处理 issue、拉取请求、评审、仓库文件和 Actions 运行，经由
+GitHub 的远程 MCP 服务器。每位成员连接自己的 GitHub 账号，所以智能体只能看到和修改这个人能看到和修改的
+内容，GitHub 的审计日志里记的也是这个人。
+
+::: audience admin
+组织管理员只需设置一次：在 GitHub 上注册一个应用，再把它的 client id 和 secret 填到这里。之后成员各自连接。
+
+## 1. 注册 GitHub App（推荐）
+
+GitHub App 发给成员的令牌只有下面列出的权限，只能访问安装了这个应用的仓库，并且八小时后过期（Capybara
+会自动刷新）。
+
+打开存放仓库的 GitHub 组织的 **Settings → Developer settings → GitHub Apps → New GitHub App**
+（`https://github.com/organizations/<org>/settings/apps/new`），按下面填写，未列出的项保持默认。
+
+```yaml title="GitHub App 设置（GitHub 连接器）"
+# GitHub App for the "{{templateName}}" connector template ({{pluginName}} {{pluginVersion}}).
+# Reference: https://docs.github.com/apps/creating-github-apps (checked 2026-11-12).
+GitHub App name: "Capybara connector"
+Homepage URL: "{{publicUrl}}"
+Callback URL: "{{oauthCallbackUrl}}"
+Expire user authorization tokens: on
+Request user authorization (OAuth) during installation: off
+Enable Device Flow: off
+Webhook Active: off
+Repository permissions:
+  Actions: Read and write        # read runs and logs, re-run workflows
+  Checks: Read-only
+  Commit statuses: Read-only
+  Contents: Read and write       # files, branches, commits, merges
+  Issues: Read and write
+  Metadata: Read-only            # mandatory
+  Pull requests: Read and write
+  Workflows: Read and write      # change files under .github/workflows
+Organization permissions:
+  Members: Read-only             # teams
+Account permissions:
+  Email addresses: Read-only
+Where can this GitHub App be installed: Only on this account
+```
+
+::check capybara:public-url 平台有公网地址
+
+然后在组织上 **Install App**，选择全部仓库或允许智能体操作的那些仓库。成员令牌的范围永远不会超出成员本人的
+权限与这次安装的交集。
+
+### 改用 OAuth App
+
+也可以用 OAuth App（**Settings → Developer settings → OAuth Apps → New OAuth App**，授权回调地址填
+`{{oauthCallbackUrl}}`）。它的令牌不会过期，带着本模板申请的经典 scope（`repo`、`read:org`、`read:user`、
+`user:email`、`workflow`），覆盖成员能访问的所有仓库。如果组织限制了 OAuth App 访问，需要组织所有者在
+**Settings → Third-party access** 里批准这个应用。
+
+## 2. 填写客户端
+
+复制应用的 **Client ID**，生成一个 **client secret**，把两者填到下面的字段里。secret 加密保存，之后只显示「已设置」。
+
+::check capybara:oauth-client 已填写 client id 和 secret
+::check capybara:oauth-token-endpoint GitHub 接受这个 client id 和 secret
+::check capybara:connector-tools 已有成员连接并读到工具列表
+
+## 工具与审批
+
+本模板开启 GitHub 的 `context`、`repos`、`issues`、`pull_requests`、`users` 和 `actions` 工具集（端点请求头
+`X-MCP-Toolsets`，可编辑以增减工具集）。读取类操作直接执行；写入（创建 issue 和拉取请求、评论与评审、合并、
+推送文件、创建分支、重新运行工作流）会先征求成员同意；删除仓库默认禁止。每个工具的策略都可以在连接器页面单独修改。
+
+使用带数据驻留的 GitHub Enterprise Cloud 时，把端点地址改为
+`https://copilot-api.<your-subdomain>.ghe.com/mcp`，并在那个域名上注册应用。
+:::
+
+::: audience member
+## 连接你的 GitHub 账号
+
+选择**连接**，在 GitHub 的授权页面上同意。之后智能体以你的身份操作 GitHub，写入操作会先问你（除非管理员改了
+设置）。智能体只能看到你能看到的仓库；使用 GitHub App 时，还只限于安装了这个应用的仓库。
+
+**断开连接**会删除 Capybara 里的令牌。如果还要在 GitHub 上吊销，打开 **Settings → Applications →
+Authorized GitHub Apps**（或 **Authorized OAuth Apps**）撤销这个应用。
+
+::check capybara:connector-connected 你的 GitHub 账号已连接
+:::

package/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="-1 -1 18 18"><title>GitHub</title><path fill="#1f2328" d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"/></svg>

package/package.json

@@ -1,6 +1,13 @@
 {
   "name": "@capybara-hq/plugin-github",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-rc.1",
+  "type": "module",
+  "license": "Apache-2.0",
+  "description": "GitHub connector template: issues, pull requests, reviews, repositories and Actions through GitHub's remote MCP server, as the connected person (OAuth through a GitHub App or OAuth App)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/capybara-hq/plugins.git",
+    "directory": "plugins/github"
+  },
+  "homepage": "https://github.com/capybara-hq/plugins/tree/main/plugins/github#readme"
+}