Github Enterprise MCP

🚀 GitHub Enterprise MCP Server Documentation

GitHub Enterprise MCP (Management Console Protocol) Server is a tool for interacting with GitHub Enterprise instances. It enables users to directly utilize various GitHub Enterprise features through Cursor's AI chat function, including repository management, code review, issue tracking, etc.

🚀 Quick Start

Installation and Configuration

To install and configure the GitHub Enterprise MCP Server, follow these steps:

1. Download the Server

   • Download the latest version of the server from the GitHub repository.

2. Environment Variable Configuration

   • Set the necessary environment variables:

   export GHE_HOST=your-enterprise-host.com
   export GHE_PORT=443
   export GITHUB_TOKEN=your PAT token
   

3. Start the Server

   • Start the server using the command:

   npm start --prefix path/to/mcp-server
   

✨ Features

Environment Variables and Command-Line Arguments

• Environment Variables:

  • GHE_HOST: The hostname of the GitHub Enterprise instance.
  • GHE_PORT: The port used by the GitHub Enterprise instance, defaulting to 443.
  • GITHUB_TOKEN: The personal access token (PAT) for authentication.

• Command-Line Arguments:

  • --host: Customize the server binding address, e.g., --host 0.0.0.0.
  • --port: Customize the server port, e.g., --port 3000.
  • --config: Specify the configuration file path, e.g., --config ./config.json.

Enterprise-Level Features

The GitHub Enterprise MCP Server supports the following enterprise-level features:

• Code Review
• Dependency Management
• Security Scanning
• Repository Policies

💻 Usage Examples

Basic Usage

Here are examples of using GitHub Enterprise tools in Cursor's AI chat:

List Repositories

mcp_github_enterprise_列出仓库(owner="octocat")

Get Repository Information

mcp_github_enterprise_获取仓库(owner="octocat", repo="hello-world")

List Pull Requests

mcp_github_enterprise_列出拉取请求(owner="octocat", repo="hello-world", state="open")

Manage Issues

// List issues
mcp_github_enterprise_列出问题(owner="octocat", repo="hello-world", state="all")
// Get issue details
mcp_github_enterprise_获取问题(owner="octocat", repo="hello-world", issue_number=1)

// Get issue/pull request comments
mcp_github_enterprise_列出问题评论(owner="octocat", repo="hello-world", issue_number=1)

Create a New Issue

mcp_github_enterprise_创建问题(
  owner="octocat",
  repo="hello-world",
  title="发现了一个错误",
  body="这里是对错误的描述",
  labels=["bug", "important"]
)

Operate on Repository Content

mcp_github_enterprise_获取内容(owner="octocat", repo="hello-world", 路径="README.md")

Manage Repository Settings

// Create a new repository
mcp_github_enterprise_创建仓库(
  name="new-project",
  description="这是一个新项目",
  private=true,
  auto_init=true
)

// Update repository settings
mcp_github_enterprise_更新仓库(
  owner="octocat",
  repo="hello-world",
  description="更新后的描述",
  has_issues=true
)

Advanced Usage

Example: Set Repository Policies

mcp_github_enterprise_设置仓库策略(
  owner="octocat",
  repo="hello-world",
  required_linear_history=true,
  required_signatures=true
)

📚 Documentation

Notes

1. Permission Requirements

   • All enterprise-level features require a valid personal access token (PAT).
   • Some features require site administrator privileges.

2. Error Handling

   • If any errors occur, check the log files and ensure the token permissions are correct.

3. Performance Optimization

   • It is recommended to use a reverse proxy and load balancer under high-load conditions.

Contribution Guidelines

1. Issue Reporting

   • Report any issues to the GitHub repository issues section.

2. Code Contribution

   • Fork the repository, make changes on your branch, and then create a Pull Request.

3. Feedback

   • Your comments and suggestions are welcome via email or on GitHub.

📄 License

The GitHub Enterprise MCP Server is licensed under the MIT License, allowing both personal and commercial use.