{
  "schemaVersion": "1.0",
  "item": {
    "slug": "read-github",
    "name": "Read GitHub",
    "source": "tencent",
    "type": "skill",
    "category": "效率提升",
    "sourceUrl": "https://clawhub.ai/am-will/read-github",
    "canonicalUrl": "https://clawhub.ai/am-will/read-github",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/read-github",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=read-github",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md",
      "scripts/gitmcp.py"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "Download the package from Yavira.",
        "Extract it into a folder your agent can access.",
        "Paste one of the prompts below and point your agent at the extracted folder."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
        },
        {
          "label": "Upgrade existing",
          "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-30T16:55:25.780Z",
      "expiresAt": "2026-05-07T16:55:25.780Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
        "contentDisposition": "attachment; filename=\"network-1.0.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/read-github"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/read-github",
    "agentPageUrl": "https://openagent3.xyz/skills/read-github/agent",
    "manifestUrl": "https://openagent3.xyz/skills/read-github/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/read-github/agent.md"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "Download the package from Yavira.",
      "Extract it into a folder your agent can access.",
      "Paste one of the prompts below and point your agent at the extracted folder."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
      },
      {
        "label": "Upgrade existing",
        "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "Read GitHub Docs",
        "body": "Access GitHub repository documentation and code via the gitmcp.io MCP service."
      },
      {
        "title": "URL Conversion",
        "body": "Convert GitHub URLs to gitmcp.io:\n\ngithub.com/owner/repo → gitmcp.io/owner/repo\nhttps://github.com/karpathy/llm-council → https://gitmcp.io/karpathy/llm-council"
      },
      {
        "title": "CLI Usage",
        "body": "The scripts/gitmcp.py script provides CLI access to repository docs."
      },
      {
        "title": "List Available Tools",
        "body": "python3 scripts/gitmcp.py list-tools owner/repo"
      },
      {
        "title": "Fetch Documentation",
        "body": "Retrieves the full documentation file (README, docs, etc.):\n\npython3 scripts/gitmcp.py fetch-docs owner/repo"
      },
      {
        "title": "Search Documentation",
        "body": "Semantic search within repository documentation:\n\npython3 scripts/gitmcp.py search-docs owner/repo \"query\""
      },
      {
        "title": "Search Code",
        "body": "Search code using GitHub Search API (exact match):\n\npython3 scripts/gitmcp.py search-code owner/repo \"function_name\""
      },
      {
        "title": "Fetch Referenced URL",
        "body": "Fetch content from URLs mentioned in documentation:\n\npython3 scripts/gitmcp.py fetch-url owner/repo \"https://example.com/doc\""
      },
      {
        "title": "Direct Tool Call",
        "body": "Call any MCP tool directly:\n\npython3 scripts/gitmcp.py call owner/repo tool_name '{\"arg\": \"value\"}'"
      },
      {
        "title": "Tool Names",
        "body": "Tool names are dynamically prefixed with the repo name (underscored):\n\nkarpathy/llm-council → fetch_llm_council_documentation\nfacebook/react → fetch_react_documentation\nmy-org/my-repo → fetch_my_repo_documentation"
      },
      {
        "title": "Available MCP Tools",
        "body": "For any repository, these tools are available:\n\nfetch_{repo}_documentation - Fetch entire documentation. Call first for general questions.\nsearch_{repo}_documentation - Semantic search within docs. Use for specific queries.\nsearch_{repo}_code - Search code via GitHub API (exact match). Returns matching files.\nfetch_generic_url_content - Fetch any URL referenced in docs, respecting robots.txt."
      },
      {
        "title": "Workflow",
        "body": "When given a GitHub repo, first fetch documentation to understand the project\nUse search-docs for specific questions about usage or features\nUse search-code to find implementations or specific functions\nUse fetch-url to retrieve external references mentioned in docs"
      }
    ],
    "body": "Read GitHub Docs\n\nAccess GitHub repository documentation and code via the gitmcp.io MCP service.\n\nURL Conversion\n\nConvert GitHub URLs to gitmcp.io:\n\ngithub.com/owner/repo → gitmcp.io/owner/repo\nhttps://github.com/karpathy/llm-council → https://gitmcp.io/karpathy/llm-council\nCLI Usage\n\nThe scripts/gitmcp.py script provides CLI access to repository docs.\n\nList Available Tools\npython3 scripts/gitmcp.py list-tools owner/repo\n\nFetch Documentation\n\nRetrieves the full documentation file (README, docs, etc.):\n\npython3 scripts/gitmcp.py fetch-docs owner/repo\n\nSearch Documentation\n\nSemantic search within repository documentation:\n\npython3 scripts/gitmcp.py search-docs owner/repo \"query\"\n\nSearch Code\n\nSearch code using GitHub Search API (exact match):\n\npython3 scripts/gitmcp.py search-code owner/repo \"function_name\"\n\nFetch Referenced URL\n\nFetch content from URLs mentioned in documentation:\n\npython3 scripts/gitmcp.py fetch-url owner/repo \"https://example.com/doc\"\n\nDirect Tool Call\n\nCall any MCP tool directly:\n\npython3 scripts/gitmcp.py call owner/repo tool_name '{\"arg\": \"value\"}'\n\nTool Names\n\nTool names are dynamically prefixed with the repo name (underscored):\n\nkarpathy/llm-council → fetch_llm_council_documentation\nfacebook/react → fetch_react_documentation\nmy-org/my-repo → fetch_my_repo_documentation\nAvailable MCP Tools\n\nFor any repository, these tools are available:\n\nfetch_{repo}_documentation - Fetch entire documentation. Call first for general questions.\nsearch_{repo}_documentation - Semantic search within docs. Use for specific queries.\nsearch_{repo}_code - Search code via GitHub API (exact match). Returns matching files.\nfetch_generic_url_content - Fetch any URL referenced in docs, respecting robots.txt.\nWorkflow\nWhen given a GitHub repo, first fetch documentation to understand the project\nUse search-docs for specific questions about usage or features\nUse search-code to find implementations or specific functions\nUse fetch-url to retrieve external references mentioned in docs"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/am-will/read-github",
    "publisherUrl": "https://clawhub.ai/am-will/read-github",
    "owner": "am-will",
    "version": "1.0.1",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/read-github",
    "downloadUrl": "https://openagent3.xyz/downloads/read-github",
    "agentUrl": "https://openagent3.xyz/skills/read-github/agent",
    "manifestUrl": "https://openagent3.xyz/skills/read-github/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/read-github/agent.md"
  }
}