Github MCP Server 020

🚀 GitHub MCP API Documentation

This documentation provides a detailed guide on using the GitHub MCP API, including operations for repositories, code scanning, search, and more.

🚀 Quick Start

Install the Go Library

To start using the GitHub MCP API, you need to install the Go library.

go get github.com/yourusername/github-mcp-api/v1

✨ Features

Repository Operations

Pull Requests

Get Pull Request Contents

Retrieves the contents of a pull request.

• Template: repos/{owner}/{repo}/pulls/{pull_number}
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • pull_number: Pull request number (integer, required)

Create a Pull Request

Creates a new pull request.

• Template: repos/{owner}/{repo}/pulls
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • title: Pull request title (string, required)
  • head: Head branch of the pull request (string, required)
  • base: Base branch of the pull request (string, required)

Update a Pull Request

Updates an existing pull request.

• Template: repos/{owner}/{repo}/pulls/{pull_number}
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • pull_number: Pull request number (integer, required)
  • title: New pull request title (string, optional)
  • head: New head branch (string, optional)
  • base: New base branch (string, optional)

Delete a Pull Request

Deletes a pull request.

• Template: repos/{owner}/{repo}/pulls/{pull_number}
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • pull_number: Pull request number (integer, required)

Code Scanning

Get Code Scanning Alerts

Gets specific code scanning alerts.

• Template: repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • alert_number: Alert number (integer, required)

List Code Scanning Alerts

Lists all code scanning alerts in a repository.

• Template: repos/{owner}/{repo}/code-scanning/alerts
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • ref: Git reference (string, optional)
  • state: Alert state (string, optional)
  • severity: Alert severity (string, optional)

Search

Search Code

Searches for code on GitHub.

• Template: /search/code
• Parameters:
  • query: Search query (string, required)
  • sort: Sort field (string, optional)
  • order: Sort order (string, optional)

Search Repositories

Searches for repositories on GitHub.

• Template: /search/repos
• Parameters:
  • query: Search query (string, required)
  • sort: Sort field (string, optional)
  • order: Sort order (string, optional)

Resources

Get Repository Contents

Gets files and directories in a repository.

• Template: repos/{owner}/{repo}/contents
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • path: File path (string, optional)

Get a Commit

Gets specific commit information.

• Template: repos/{owner}/{repo}/commits/{commit_hash}
• Parameters:
  • owner: Repository owner (string, required)
  • repo: Repository name (string, required)
  • commit_hash: Commit hash (string, required)

💻 Usage Examples

Basic Usage

Get Repository Information

package main

import (
    "fmt"
    "github.com/yourusername/github-mcp-api/v1"
)

func main() {
    client := github.NewClient(nil)
    repo, _, err := client.Repositories.Get("yourusername", "yourrepo")
    if err != nil {
        fmt.Printf("Error: %v", err)
        return
    }
    fmt.Printf("Repository name: %s", repo.Name)
}

📄 License

MIT License

Copyright (c) 2023 GitHub MCP Team
This software is licensed under the MIT License.

License terms:

1. Both personal and commercial use are permitted.
2. Modification and distribution are permitted, but the copyright notice and license notice must be retained.