GitHub REST API
GitHub REST API for searching repositories, inspecting users and organizations, and reading repository issues, commits, contents, and metadata.
Connect this API to an AI agent Browse all specs
What you can do with GitHub REST API via MCP
Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.
| Method | Path | Operation | Description |
|---|---|---|---|
| GET | /search/repositories |
get_search_repositories | Search GitHub repositories Method: GET Path: /search/repositories IMPORTANT: This function has 1 REQUIRED parameter(s) and 2 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Query Parameters: REQUIRED: - q: Search keywords and qualifiers OPTIONAL: - per_page: Results per page - page: Page number |
| GET | /users/{username} |
get_users_username | Get a public user profile Method: GET Path: /users/{username} IMPORTANT: This function has 1 REQUIRED parameter(s) and 0 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - username: GitHub login |
| GET | /orgs/{org}/repos |
get_orgs_org_repos | List public repositories for an organization Method: GET Path: /orgs/{org}/repos IMPORTANT: This function has 1 REQUIRED parameter(s) and 2 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - org: Organization login Query Parameters: OPTIONAL: - per_page: Results per page - page: Page number |
| GET | /repos/{owner}/{repo} |
get_repos_owner_repo | Get repository metadata Method: GET Path: /repos/{owner}/{repo} IMPORTANT: This function has 2 REQUIRED parameter(s) and 0 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - owner: Repository owner - repo: Repository name |
| GET | /repos/{owner}/{repo}/issues |
get_repos_owner_repo_issues | List repository issues Method: GET Path: /repos/{owner}/{repo}/issues IMPORTANT: This function has 2 REQUIRED parameter(s) and 2 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - owner: Repository owner - repo: Repository name Query Parameters: OPTIONAL: - state: Issue state - per_page: Results per page |
| GET | /repos/{owner}/{repo}/commits |
get_repos_owner_repo_commits | List repository commits Method: GET Path: /repos/{owner}/{repo}/commits IMPORTANT: This function has 2 REQUIRED parameter(s) and 2 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - owner: Repository owner - repo: Repository name Query Parameters: OPTIONAL: - per_page: Results per page - page: Page number |
| GET | /repos/{owner}/{repo}/contents/{path} |
get_repos_owner_repo_contents_path | Get repository file or directory contents Method: GET Path: /repos/{owner}/{repo}/contents/{path} IMPORTANT: This function has 3 REQUIRED parameter(s) and 1 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - owner: Repository owner - repo: Repository name - path: Repository-relative path Query Parameters: OPTIONAL: - ref: Branch, tag, or commit |
Usage guide
Create a fine-grained personal access token in GitHub Settings > Developer settings > Personal access tokens. Send it as `Authorization: Bearer YOUR_GITHUB_TOKEN`; public read endpoints can work without a token but authenticated requests receive higher limits. Store the token server-side and review current permissions and REST version headers in the official documentation. Official documentation: https://docs.github.com/en/rest
How to use this spec
- Create a free VX Agents account (sandbox tools included).
- Open the marketplace and connect “GitHub REST API” to an agent.
- Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.