mcpField
G
github-docs

github-docs

github.com/fandhe-ai开发41.4k 次安装2 天前更新
代码仓库

关于 github-docs

用于查阅 GitHub 官方文档主要部分的参考技能。它将任务映射到文档类别，再通过 README 索引定位具体页面，帮助用户查找所需内容。

主要功能

  1. 01任务到文档类别的映射
  2. 02通过 README 查找页面
  3. 03覆盖 GitHub Actions 与 API
  4. 04安全工作流示例指南

适用场景

  1. 01查找 GitHub Actions 配置文档
  2. 02定位 REST 或 GraphQL API 指南
  3. 03查阅身份验证与仓库主题
  4. 04检查更安全的 CI 工作流示例

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/fandhe-ai/agent-reference-skills --skill github-docs

安装后在 Claude Code 中输入/github-docs确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/actions/
artifact-attestations.md
artifacts.md
caching.md
composite-actions.md
concurrency.md
contexts.md
environment-variables.md
events-triggers.md
expressions.md
limits.md
lockfiles.md
oidc.md
permissions.md
README.md
reusable-workflows.md
runners.md
secrets.md
workflow-commands.md
workflow-syntax.md
references/actions/creating-actions/
action-metadata.md
docker-actions.md
immutable-releases.md
javascript-actions.md
README.md
references/apps/
about.md
authentication.md
creating.md
installation.md
oauth-apps.md
permissions-events.md

详细介绍

GitHub 文档参考

涵盖 GitHub 官方文档（docs.github.com）主要章节的技能。

来源：docs.github.com Article Body API（free-pro-team@latest），获取日期为 2026-10-17。REST 按 X-GitHub-Api-Version 2026-03-10 编写（省略标头时，默认值为 2022-11-28）。 请根据用户的任务阅读相应的 README.md，并从中找到具体文件。

目录结构

skills/github-docs/
  SKILL.md
  references/
    actions/
      README.md
      artifact-attestations.md
      artifacts.md
      caching.md
      composite-actions.md
      concurrency.md
      contexts.md
      environment-variables.md
      events-triggers.md
      expressions.md
      limits.md
      lockfiles.md
      oidc.md
      permissions.md
      reusable-workflows.md
      runners.md
      secrets.md
      workflow-commands.md
      workflow-syntax.md
      creating-actions/
        README.md
        action-metadata.md
        docker-actions.md
        immutable-releases.md
        javascript-actions.md
    apps/
      README.md
      about.md
      authentication.md
      creating.md
      installation.md
      oauth-apps.md
      permissions-events.md
      webhooks.md
    authentication/
      README.md
      deploy-keys.md
      personal-access-tokens.md
      saml-sso.md
      ssh-keys.md
      two-factor-auth.md
    cli/
      README.md
      extensions.md
      quickstart.md
      reference.md
    graphql/
      README.md
      forming-calls.md
      overview.md
      pagination.md
      rate-limits.md
      schema-reference.md
    pages/
      README.md
      configuration.md
      custom-domains.md
      getting-started.md
    projects/
      README.md
      graphql-api.md
      rest-api.md
    pull-requests/
      README.md
      code-owners.md
      conflicts.md
      creating.md
      merging.md
      reviewing.md
    repositories/
      README.md
      branches.md
      creating-managing.md
      files.md
      releases-tags.md
      settings.md
      templates.md
    rest-api/
      README.md
      agent-tasks/
        README.md
        agent-tasks.md
      agents/
        README.md
        secrets.md
        variables.md
      billing/
        README.md
        budgets.md
        usage.md
      campaigns/
        README.md
        campaigns.md
      actions/
        README.md
        artifacts.md
        cache.md
        concurrency-groups.md
        oidc.md
        secrets.md
        self-hosted-runners.md
        variables.md
        workflow-jobs.md
        workflow-runs.md
        workflows.md
      activity/
        events.md
        notifications.md
        starring.md
        watching.md
      checks/
        README.md
        check-runs.md
        check-suites.md
      codespaces/
        codespaces.md
      copilot/
        README.md
        cloud-agent-management.md
        coding-agent-management.md
        content-exclusion-management.md
        spaces.md
        usage-metrics.md
        user-management.md
      dependency-graph/
        README.md
        dependency-review.md
        dependency-submission.md
        sboms.md
      deployments/
        README.md
        deployments.md
        environments.md
      gists/
        README.md
        gists.md
      git/
        README.md
        blobs.md
        commits.md
        refs.md
        tags.md
        trees.md
      issues/
        README.md
        assignees.md
        comments.md
        issues.md
        labels.md
        milestones.md
      orgs/
        README.md
        orgs.md
      overview/
        about.md
        api-versions.md
        authentication.md
        best-practices.md
        pagination.md
        permissions.md
        rate-limits.md
        troubleshooting.md
      packages/
        README.md
        packages.md
      pages/
        README.md
        pages.md
      projects/
        fields.md
        items.md
        projects.md
      pulls/
        README.md
        pulls.md
        review-comments.md
        review-requests.md
        reviews.md
      repos/
        README.md
        branches.md
        collaborators.md
        commits.md
        contents.md
        deploy-keys.md
        releases.md
        repos.md
        tags.md
        webhooks.md
      search/
        README.md
        search.md
      security/
        README.md
        code-scanning.md
        dependabot-alerts.md
        dependabot-repository-access.md
        dependabot-secrets.md
        secret-scanning.md
        secret-scanning-push-protection.md
      teams/
        README.md
        members.md
        teams.md
      users/
        README.md
        users.md
    webhooks/
      README.md
      about.md
      best-practices.md
      creating.md
      events.md
      securing.md
  samples/
    README.md
    cache-dependencies.md
    ci-node.md
    composite-action.md
    concurrency-deploy-queue.md
    deploy-on-push.md
    manual-dispatch.md
    matrix-build.md
    oidc-aws-deploy.md
    pr-auto-comment.md
    rest-api-call.md
    reusable-workflow-deploy.md
    scheduled-workflow.md
    secret-usage.md
  scripts/
    README.md
    api.md
    auth.md
    cli.md
    extensions.md
    generate.md
    install.md

探索步骤

根据任务确定类别，然后在类别的 README.md 中找到目标页面：

  1. 在下方的映射表中查找与任务对应的类别
  2. 参阅该类别的 references/{category}/README.md，找到目标页面
  3. Read 相应的 .md 文件以查看详细信息

使用 samples 时的安全规范

samples/ 中的示例将被原样复制，并成为使用方仓库中的 CI。为避免复制时传播危险写法，所有示例都必须满足以下要求。

  • 外部 action 和其他仓库的 reusable workflow 必须通过固定的提交 SHA引用（在末尾注释中注明版本）。@v4 / @main 等可变 ref 可以被替换，可能成为供应链攻击的入口
  • 不要将 ${{ ... }} 直接展开到 run: 正文或 actions/github-script 的 script: 正文中。应将其传递到 env:，并在 shell 中使用 "${VAR}"、在 JavaScript 中使用 process.env.VAR 引用
  • 明确设置作业的 permissions，并遵循最小权限原则。确保在默认权限为只读的仓库中也能运行
  • 每个 run: 都必须使用多行块（run: |），并在开头添加 set -euo pipefail。同时，在工作流的步骤中明确设置 shell: bash。这样可以避免忽略未定义变量或管道中途失败的情况
  • 引用 $GITHUB_OUTPUT 等环境变量时，使用引号 "${GITHUB_OUTPUT}"
  • 处理 fork PR 时，不要直接将其替换为 pull_request_target。应将其拆分为不会执行 PR 代码的作业（参见 samples/pr-auto-comment.md）

任务 → 类别映射

タスクカテゴリ参照 README
ワークフロー構文・CI/CD 設定、イベントトリガー、シークレット、キャッシュ、アーティファクトactionsreferences/actions/README.md
ワークフローコマンド（::add-mask:: / GITHUB_OUTPUT / ジョブサマリー）、concurrency と queue、Actions の制限値actionsreferences/actions/README.md
OIDC クラウド連携（id-token）、lockfile（gh actions-lock）、artifact attestationsactionsreferences/actions/README.md
カスタムアクション作成（JavaScript・Docker・複合アクション）、immutable releasesactions/creating-actionsreferences/actions/creating-actions/README.md
GitHub App 作成・認証・インストール、OAuth Apps との比較appsreferences/apps/README.md
SSH キー・PAT・2FA・SAML SSO・デプロイキーauthenticationreferences/authentication/README.md
gh コマンド、CLI クイックスタート、CLI 拡張機能clireferences/cli/README.md
GraphQL クエリ・ミューテーション・スキーマ・ページネーションgraphqlreferences/graphql/README.md
GitHub Pages 作成・設定・カスタムドメインpagesreferences/pages/README.md
GitHub Projects（v2）の GraphQL / REST API 操作projectsreferences/projects/README.md
PR 作成・レビュー・マージ、CODEOWNERS、コンフリクト解決pull-requestsreferences/pull-requests/README.md
リポジトリ作成・設定、ブランチ保護、リリース・タグ管理repositoriesreferences/repositories/README.md
REST API 概要・認証・レート制限・ページネーションrest-api/overviewreferences/rest-api/README.md
Actions API（ワークフロー・シークレット・アーティファクト等）rest-api/actionsreferences/rest-api/actions/README.md
アクティビティ API（イベント・通知・スター・ウォッチ）rest-api/activityreferences/rest-api/README.md
チェック API（check-runs・check-suites）rest-api/checksreferences/rest-api/checks/README.md
Codespaces APIrest-api/codespacesreferences/rest-api/README.md
Copilot API（利用状況メトリクス・ユーザー管理・Spaces・cloud agent 管理・content exclusion）rest-api/copilotreferences/rest-api/copilot/README.md
Dependency graph API（dependency review / submission / SBOM）rest-api/dependency-graphreferences/rest-api/dependency-graph/README.md
Agent tasks API（Copilot cloud agent タスク）rest-api/agent-tasksreferences/rest-api/agent-tasks/README.md
Agents secrets / variables APIrest-api/agentsreferences/rest-api/agents/README.md
Security campaigns APIrest-api/campaignsreferences/rest-api/campaigns/README.md
Teams API（チーム・メンバー）rest-api/teamsreferences/rest-api/teams/README.md
Billing API（budgets / usage）rest-api/billingreferences/rest-api/billing/README.md
デプロイ・環境 APIrest-api/deploymentsreferences/rest-api/deployments/README.md
Gist APIrest-api/gistsreferences/rest-api/gists/README.md
Git データ API（blobs・commits・refs・tags・trees）rest-api/gitreferences/rest-api/git/README.md
Issue API（ラベル・マイルストーン・コメント・担当者）rest-api/issuesreferences/rest-api/issues/README.md
Organization APIrest-api/orgsreferences/rest-api/orgs/README.md
パッケージ APIrest-api/packagesreferences/rest-api/packages/README.md
Pages APIrest-api/pagesreferences/rest-api/pages/README.md
Projects（v2）REST API（items・fields）rest-api/projectsreferences/rest-api/README.md
PR API（レビュー・レビューコメント・レビューリクエスト）rest-api/pullsreferences/rest-api/pulls/README.md
リポジトリ API（ブランチ・コンテンツ・リリース・Webhook）rest-api/reposreferences/rest-api/repos/README.md
検索 APIrest-api/searchreferences/rest-api/search/README.md
セキュリティ API（code scanning・secret scanning・Dependabot alerts/secrets/repository access）rest-api/securityreferences/rest-api/security/README.md
ユーザー APIrest-api/usersreferences/rest-api/users/README.md
Webhook 作成・イベントペイロード・セキュリティ・ベストプラクティスwebhooksreferences/webhooks/README.md
典型的な Actions ワークフロー・デプロイ・CI パターンを知りたいsamplessamples/README.md
gh CLI インストール・認証・API 呼び出しコマンドを知りたいscriptsscripts/README.md

评论

支持 Markdown