Read Github logo

Read Github

CommunityPopular
am-will
read-github

Read and search GitHub repository documentation via gitmcp.io MCP service. **WHEN TO USE:** - User provides a GitHub URL - User mentions a specific repo in owner/repo format - User asks "what does this repo do?", "read the docs for X repo", or similar - User wants to search code or docs within a repo

Overview

Publisheram-will
Repositorycodex-skills
Skill nameread-github
Stars
1K
Forks
60
Bundled files
1
Links
Skill sourceRepository
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 1 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by am-will on GitHub. Read the source before you install it.

Installation

Install the Read Github AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/am-will/codex-skills.git /tmp/codex-skills
mkdir -p .claude/skills
cp -r /tmp/codex-skills/skills/read-github .claude/skills/read-github
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Read Github in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Read Github on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Read Github is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Read GitHub Docs

Access GitHub repository documentation and code via the gitmcp.io MCP service.

URL Conversion

Convert GitHub URLs to gitmcp.io:

  • github.com/owner/repo → gitmcp.io/owner/repo
  • https://github.com/karpathy/llm-council → https://gitmcp.io/karpathy/llm-council

CLI Usage

The scripts/gitmcp.py script provides CLI access to repository docs.

List Available Tools

bash
python3 scripts/gitmcp.py list-tools owner/repo

Fetch Documentation

Retrieves the full documentation file (README, docs, etc.):

bash
python3 scripts/gitmcp.py fetch-docs owner/repo

Search Documentation

Semantic search within repository documentation:

bash
python3 scripts/gitmcp.py search-docs owner/repo "query"

Search Code

Search code using GitHub Search API (exact match):

bash
python3 scripts/gitmcp.py search-code owner/repo "function_name"

Fetch Referenced URL

Fetch content from URLs mentioned in documentation:

bash
python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"

Direct Tool Call

Call any MCP tool directly:

bash
python3 scripts/gitmcp.py call owner/repo tool_name '{"arg": "value"}'

Tool Names

Tool names are dynamically prefixed with the repo name (underscored):

  • karpathy/llm-council → fetch_llm_council_documentation
  • facebook/react → fetch_react_documentation
  • my-org/my-repo → fetch_my_repo_documentation

Available MCP Tools

For any repository, these tools are available:

  1. fetch_{repo}_documentation - Fetch entire documentation. Call first for general questions.
  2. search_{repo}_documentation - Semantic search within docs. Use for specific queries.
  3. search_{repo}_code - Search code via GitHub API (exact match). Returns matching files.
  4. fetch_generic_url_content - Fetch any URL referenced in docs, respecting robots.txt.

Workflow

  1. When given a GitHub repo, first fetch documentation to understand the project
  2. Use search-docs for specific questions about usage or features
  3. Use search-code to find implementations or specific functions
  4. Use fetch-url to retrieve external references mentioned in docs

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Read Github AI skill do?

Read and search GitHub repository documentation via gitmcp.io MCP service. **WHEN TO USE:** - User provides a GitHub URL - User mentions a specific repo in owner/repo format - User asks "what does this repo do?", "read the docs for X repo", or similar - User wants to search code or docs within a repo

Why use Read Github on TypingMind?

Because you install it once and use it with any model. Read Github is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Read Github in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/am-will/codex-skills/tree/main/skills/read-github. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Read Github?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Read Github?

As many as you like. As long as a model supports skills, you can use Read Github with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Read Github AI skill free?

It is published on GitHub by am-will. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

Related AI Skills

View all
obra logo

Receiving Code Review

obra
CommunityPopular

Use when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative…

25.8K
288.1K
Instructions
View
obra logo

Requesting Code Review

obra
CommunityPopular

Use when completing tasks, implementing major features, or before merging to verify work meets requirements

25.8K
288.1K
1 files
View
obra logo

Systematic Debugging

obra
CommunityPopular

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes

25.8K
288.1K
10 files
View
obra logo

Test Driven Development

obra
CommunityPopular

Use when implementing any feature or bugfix, before writing implementation code

25.8K
288.1K
1 files
View

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇