Github MCP Server

🚀 GitHub MCP Server

A Model Context Protocol (MCP) server that offers GitHub integration capabilities. This server interacts with GitHub repositories through the MCP tool, supporting functions such as repository management, file operations, and commit processing.

✨ Features

• Account management and authentication
• Repository creation and management
• File operations (read, write, push, pull)
• Commit operations
• Directory synchronization
• Repository comparison and difference analysis

📦 Installation

npm install @modelcontextprotocol/server-github

🛠️ Configuration

Add the server to your MCP settings file (cline_mcp_settings.json):

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": ["/path/to/github-mcp-server/dist/index.js"],
      "env": {
        "GITHUB_TOKEN_1": "your-github-token",
        "GITHUB_OWNER_1": "your-github-username"
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

💻 Usage Examples

Account Management

list_accounts

List the GitHub accounts configured in the server.

select_account

Select a GitHub account for subsequent operations.

Repository Management

create_repository

Create a new GitHub repository.

{
  owner?: string;        // Repository owner (optional if an account is selected)
  name: string;          // Repository name
  description: string;   // Repository description
  private?: boolean;     // Whether it's a private repository
}

clone_repository

Clone a GitHub repository to a local directory.

{
  owner?: string;    // Repository owner
  repo: string;      // Repository name
  branch?: string;   // Branch name (default: main)
  outputDir: string; // Local directory to clone to
}

rename_repository

Rename an existing GitHub repository.

{
  owner?: string;    // Repository owner
  repo: string;      // Current repository name
  new_name: string;  // New repository name
}

File Operations

push_file

Push a file to a GitHub repository.

{
  owner?: string;     // Repository owner
  repo: string;       // Repository name
  path: string;       // Target path in the repository
  message: string;    // Commit message
  sourcePath: string; // Local file path to push
}

pull_file

Pull a file from a GitHub repository.

{
  owner?: string;     // Repository owner
  repo: string;       // Repository name
  path: string;       // File path in the repository
  outputDir: string;  // Local directory to pull to
}

delete_file

Delete a file from a GitHub repository.

{
  owner?: string;     // Repository owner
  repo: string;       // Repository name
  path: string;       // File path in the repository
}

Commit Operations

create_commit

Create a commit in a GitHub repository.

{
  owner?: string;         // Repository owner
  repo: string;           // Repository name
  branch: string;         // Branch name
  changes: {              // List of changes to commit
    path: string;        // File path
    content: string;      // File content
    mode?: string;       // File mode (optional)
  }[]
}

🛠️ Development

Install Dependencies

Install development dependencies using the following command:

npm install

Build

Build the project to generate a release version:

npm run build

⚙️ Environment Variables

• GITHUB_TOKEN_<N>: GitHub personal access token for authentication.
• GITHUB_OWNER_<N>: GitHub username or organization name.

📄 License

This project is licensed under the MIT License.