Github

🚀 GitHub MCP Server Usage Guide

This guide provides a detailed introduction to the functions, search syntax, configuration, and usage examples of the GitHub MCP server, helping you better utilize its capabilities.

✨ Features

1. Create a New Issue

• Function: createIssue
• Input Parameters:
  • owner: The name of the repository owner (e.g., octocat).
  • repo: The name of the repository (e.g., hello-world).
  • title: The title of the issue (e.g., This is a new issue).
  • body: The description of the issue.
• Output: The newly created issue object.

2. Get Repository Information

• Function: getRepositoryInfo
• Input Parameters:
  • owner: The name of the repository owner.
  • repo: The name of the repository.
• Output: An object containing detailed repository information, including members, branches, etc.

3. Get Repository Contents

• Function: getContents
• Input Parameters:
  • owner: The name of the repository owner.
  • repo: The name of the repository.
  • path: The file path (optional).
• Output: A list of files or directories under the specified path.

... (Other features are omitted)

📚 Search Syntax

Code Search

• language:javascript: Filter by programming language.
• repo:owner/name: Search within a specific repository.
• path:app/src: Search under the specified path.
• extension:js: Filter by file extension.
• Example: q: "import express" language:typescript path:src/

Issue Search

• is:issue or is:pr: Filter by type.
• is:open or is:closed: Filter by status.
• label:bug: Filter by label.
• author:username: Filter by author.
• Example: q: "memory leak" is:issue is:open label:bug

User Search

• type:user or type:org: Filter by account type.
• followers:>1000: Filter by the number of followers.
• location:London: Filter by location.
• Example: q: "fullstack developer" location:London followers:>100

📦 Installation

Personal Access Token

Create a GitHub personal access token and ensure it has the appropriate permissions:

• Visit Personal Access Tokens (in GitHub Settings > Developer Settings).
• Select the scope of repositories the token can access (public, all, or specific repositories).
• Create a token with the repo scope ("Full control of private repositories").
  • If it's only for public repositories, you can choose the public_repo scope.
• Copy the generated token.

Usage on Claude Desktop

Add the following configuration to claude_desktop_config.json:

{
  "githubMCP": {
    "token": "your_personal_access_token_here",
    "baseUrl": "https://api.github.com"
  }
}

💻 Usage Examples

Create a New Issue

Call the createIssue function:

• Input Parameters:
  • owner: octocat
  • repo: hello-world
  • title: This is a new issue
  • body: Please help me solve this problem.

Get Repository Information

Call the getRepositoryInfo function:

• Input Parameters:
  • owner: octocat
  • repo: hello-world

📚 Documentation

• GitHub API Documentation
• MCP Server Development Documentation

Please adjust the above configurations and function calls according to your actual needs.