GitHub Enterprise MCP Server

1[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/containerelic-github-enterprise-mcp-badge.png)](https://mseep.ai/app/containerelic-github-enterprise-mcp)
2 
3[![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/ddukbg/github-enterprise-mcp)](https://archestra.ai/mcp-catalog/ddukbg__github-enterprise-mcp)
4 
5# GitHub Enterprise MCP Server
6 
7![image](https://github.com/user-attachments/assets/55403caa-c81d-486a-8ec7-3a2532e7545e)
8 
9An MCP (Model Context Protocol) server for integration with GitHub Enterprise API. This server provides an MCP interface to easily access repository information, issues, PRs, and more from GitHub Enterprise in Cursor.
10 
11## Compatibility
12 
13This project is primarily designed for GitHub Enterprise Server environments, but it also works with:
14 
15- GitHub.com
16- GitHub Enterprise Cloud
17 
18> **Note**: Some enterprise-specific features (like license information and enterprise statistics) will not work with GitHub.com or GitHub Enterprise Cloud.
19 
20## Key Features
21 
22- Retrieve repository list from GitHub Enterprise instances
23- Get detailed repository information
24- List repository branches
25- View file and directory contents
26- Manage issues and pull requests
27- Repository management (create, update, delete)
28- GitHub Actions workflows management
29- User management (list, create, update, delete, suspend/unsuspend users)
30- Access enterprise statistics
31- Enhanced error handling and user-friendly response formatting
32 
33## Getting Started
34 
35### Prerequisites
36 
37- Node.js 18 or higher
38- Access to a GitHub Enterprise instance
39- Personal Access Token (PAT)
40 
41### Docker Installation and Setup
42 
43#### Option 1: Running with Docker
44 
451. Build the Docker image:
46 
47    ```bash
48    docker build -t github-enterprise-mcp .
49    ```
50 
512. Run the Docker container with environment variables:
52 
53    ```bash
54    docker run -p 3000:3000 \
55      -e GITHUB_TOKEN="your_github_token" \
56      -e GITHUB_ENTERPRISE_URL="https://github.your-company.com/api/v3" \
57      -e DEBUG=true \
58      github-enterprise-mcp
59    ```
60 
61> **Note**: The Dockerfile is configured to run with `--transport http` by default. If you need to change this, you can override the command:
62 
63```bash
64docker run -p 3000:3000 \
65  -e GITHUB_TOKEN="your_github_token" \
66  -e GITHUB_ENTERPRISE_URL="https://github.your-company.com/api/v3" \
67  -e DEBUG=true \
68  github-enterprise-mcp node dist/index.js --transport http --debug
69```
70 
71#### Option 2: Using Docker Compose
72 
731. Create a `.env` file in the project root with the required environment variables:
74 
75    ```shell
76    GITHUB_ENTERPRISE_URL=https://github.your-company.com/api/v3
77    GITHUB_TOKEN=your_github_token
78    DEBUG=true
79    ```
80 
812. Start the container with Docker Compose:
82 
83    ```bash
84    docker-compose up -d
85    ```
86 
873. Check the logs:
88 
89    ```bash
90    docker-compose logs -f
91    ```
92 
934. Stop the container:
94 
95    ```bash
96    docker-compose down
97    ```
98 
99### Installation and Setup
100 
101#### Local Development (Using Concurrent Mode)
102 
103This method is recommended for active development with automatic recompilation and server restarts:
104 
1051. Clone the repository and install required packages:
106 
107    ```bash
108    git clone https://github.com/ddukbg/github-enterprise-mcp.git
109    cd github-enterprise-mcp
110    npm install
111    ```
112 
1132. Run the development server:
114 
115    ```bash
116    export GITHUB_TOKEN="your_github_token"
117    export GITHUB_ENTERPRISE_URL="https://github.your-company.com/api/v3"
118    npm run dev
119    ```
120 
121    This will:
122    - Compile TypeScript code automatically when files change
123    - Restart the server when compiled files are updated
124    - Run the server in HTTP mode for URL-based connections
125 
1263. Connect to Cursor using URL mode as described below
127 
128### Installation and Setup for Production
129 
130#### Option 1: Using URL Mode (Recommended for Local Development)
131 
132This method is the most stable and recommended for local development or testing:
133 
1341. Clone the repository and install required packages:
135 
136    ```bash
137    git clone https://github.com/ddukbg/github-enterprise-mcp.git
138    cd github-enterprise-mcp
139    npm install
140    ```
141 
1422. Build the project:
143 
144    ```bash
145    npm run build
146    chmod +x dist/index.js
147    ```
148 
1493. Run the server:
150 
151    ```bash
152    export GITHUB_TOKEN="your_github_token"
153    export GITHUB_ENTERPRISE_URL="https://github.your-company.com/api/v3"
154    node dist/index.js --transport http --debug
155    ```
156 
1574. Connect to Cursor using URL mode:
158   - Add the following to your Cursor's `.cursor/mcp.json` file:
159 
160   ```json
161   {
162     "mcpServers": {
163       "github-enterprise": {
164         "url": "http://localhost:3000/sse"
165       }
166     }
167   }
168   ```
169 
170#### Option 2: Install as a Global Command (npm link)
171 
172This method is useful for local development:
173 
174```bash
175# After cloning the repository
176git clone https://github.com/ddukbg/github-enterprise-mcp.git
177cd github-enterprise-mcp
178 
179# Install required packages
180npm install
181 
182# Build
183npm run build
184chmod +x dist/index.js
185 
186# Link globally
187npm link
188 
189# Run as a global command
190export GITHUB_TOKEN="your_github_token"
191export GITHUB_ENTERPRISE_URL="https://github.your-company.com/api/v3"
192github-enterprise-mcp --transport=http --debug
193```
194 
195#### Option 3: Using npx (When Package is Published)
196 
197If the package is published to the public npm registry:
198 
199```bash
200npx @ddukbg/github-enterprise-mcp --token=your_github_token --github-enterprise-url=https://github.your-company.com/api/v3
201```
202 
203## Integration with AI Tools
204 
205### Claude Desktop
206 
207Add the following to your `claude_desktop_config.json`:
208 
209```json
210{
211  "mcpServers": {
212    "github-enterprise": {
213      "command": "npx",
214      "args": ["-y", "@ddukbg/github-enterprise-mcp", "--token=YOUR_GITHUB_TOKEN", "--github-enterprise-url=YOUR_GITHUB_ENTERPRISE_URL"]
215    }
216  }
217}
218```
219 
220Replace `YOUR_GITHUB_TOKEN` and `YOUR_GITHUB_ENTERPRISE_URL` with your actual values.
221 
222### Cursor
223 
224#### Recommended: URL Mode (Most Stable)
225 
226For the most reliable operation in Cursor, using URL mode is recommended:
227 
2281. Start the server in a separate terminal window:
229 
230   ```bash
231   cd /path/to/github-enterprise-mcp
232   GITHUB_ENTERPRISE_URL="https://github.your-company.com/api/v3" GITHUB_TOKEN="your_github_token" node dist/index.js --transport http
233   ```
234 
2352. Configure Cursor's MCP settings:
236   - Open Cursor and go to **Settings**
237   - Navigate to **AI > MCP Servers**
238   - Edit your `.cursor/mcp.json` file:
239 
240   ```json
241   {
242     "mcpServers": {
243       "github-enterprise": {
244         "url": "http://localhost:3000/sse"
245       }
246     }
247   }
248   ```
249 
2503. Restart Cursor to apply the changes
251 
252#### Alternative: Command Mode
253 
254Alternatively, you can configure Cursor to use the command mode, although URL mode is more reliable:
255 
2561. Open Cursor and go to **Settings**
2572. Navigate to **AI > MCP Servers**
2583. Click **Add MCP Server**
2594. Enter the following details:
260   - **Name**: GitHub Enterprise
261   - **Command**: `npx`
262   - **Arguments**: `@ddukbg/github-enterprise-mcp`
263   - **Environment Variables**:
264     - `GITHUB_ENTERPRISE_URL`: Your GitHub Enterprise API URL
265     - `GITHUB_TOKEN`: Your GitHub personal access token
266 
267Alternatively, you can manually edit your `.cursor/mcp.json` file to include:
268 
269```json
270{
271  "mcpServers": {
272    "github-enterprise": {
273      "command": "npx",
274      "args": [
275        "@ddukbg/github-enterprise-mcp"
276      ],
277      "env": {
278        "GITHUB_ENTERPRISE_URL": "https://github.your-company.com/api/v3",
279        "GITHUB_TOKEN": "your_github_token"
280      }
281    }
282  }
283}
284```
285 
286## Language Configuration
287 
288This MCP server supports both English and Korean languages. You can configure the language using:
289 
290### Environment Variables
291 
292```bash
293# Set language to Korean
294export LANGUAGE=ko
295 
296# Or in .env file
297LANGUAGE=ko
298```
299 
300### Command-line Arguments
301 
302```bash
303# Set language to Korean
304node dist/index.js --language ko
305```
306 
307The default language is English if not specified.
308 
309## Additional Options in HTTP Mode
310 
311- `--debug`: Enable debug logging
312- `--github-enterprise-url <URL>`: Set GitHub Enterprise API URL
313- `--token <TOKEN>`: Set GitHub Personal Access Token
314- `--language <LANG>`: Set language (en or ko, default: en)
315 
316## Available MCP Tools
317 
318This MCP server provides the following tools:
319 
320| Tool Name | Description | Parameters | Required PAT Permissions |
321|---|---|---|---|
322| `list-repositories` | Retrieve repository list for a user or organization | `owner`: Username/org name<br>`isOrg`: Whether it's an organization<br>`type`: Repository type<br>`sort`: Sort criteria<br>`page`: Page number<br>`perPage`: Items per page | `repo` |
323| `get-repository` | Get detailed repository information | `owner`: Repository owner<br>`repo`: Repository name | `repo` |
324| `list-branches` | List branches of a repository | `owner`: Repository owner<br>`repo`: Repository name<br>`protected_only`: Whether to show only protected branches<br>`page`: Page number<br>`perPage`: Items per page | `repo` |
325| `get-content` | Retrieve file or directory contents | `owner`: Repository owner<br>`repo`: Repository name<br>`path`: File/directory path<br>`ref`: Branch/commit (optional) | `repo` |
326| `list-pull-requests` | List pull requests in a repository | `owner`: Repository owner<br>`repo`: Repository name<br>`state`: PR state filter<br>`sort`: Sort criteria<br>`direction`: Sort direction<br>`page`: Page number<br>`per_page`: Items per page | `repo` |
327| `get-pull-request` | Get pull request details | `owner`: Repository owner<br>`repo`: Repository name<br>`pull_number`: Pull request number | `repo` |
328| `create-pull-request` | Create a new pull request | `owner`: Repository owner<br>`repo`: Repository name<br>`title`: PR title<br>`head`: Head branch<br>`base`: Base branch<br>`body`: PR description<br>`draft`: Create as draft PR | `repo` |
329| `merge-pull-request` | Merge a pull request | `owner`: Repository owner<br>`repo`: Repository name<br>`pull_number`: Pull request number<br>`merge_method`: Merge method<br>`commit_title`: Commit title<br>`commit_message`: Commit message | `repo` |
330| `list-issues` | List issues in a repository | `owner`: Repository owner<br>`repo`: Repository name<br>`state`: Issue state filter<br>`sort`: Sort criteria<br>`direction`: Sort direction<br>`page`: Page number<br>`per_page`: Items per page | `repo` |
331| `get-issue` | Get issue details | `owner`: Repository owner<br>`repo`: Repository name<br>`issue_number`: Issue number | `repo` |
332| `list-issue-comments` | List comments on an issue or pull request | `owner`: Repository owner<br>`repo`: Repository name<br>`issue_number`: Issue/PR number<br>`page`: Page number<br>`per_page`: Items per page | `repo` |
333| `create-issue` | Create a new issue | `owner`: Repository owner<br>`repo`: Repository name<br>`title`: Issue title<br>`body`: Issue body content<br>`labels`: Array of label names<br>`assignees`: Array of user logins<br>`milestone`: Milestone ID | `repo` |
334| `create-repository` | Create a new repository | `name`: Repository name<br>`description`: Repository description<br>`private`: Whether private<br>`auto_init`: Initialize with README<br>`gitignore_template`: Add .gitignore<br>`license_template`: Add license<br>`org`: Organization name | `repo` |
335| `update-repository` | Update repository settings | `owner`: Repository owner<br>`repo`: Repository name<br>`description`: New description<br>`private`: Change privacy<br>`default_branch`: Change default branch<br>`has_issues`: Enable/disable issues<br>`has_projects`: Enable/disable projects<br>`has_wiki`: Enable/disable wiki<br>`archived`: Archive/unarchive | `repo` |
336| `delete-repository` | Delete a repository | `owner`: Repository owner<br>`repo`: Repository name<br>`confirm`: Confirmation (must be true) | `delete_repo` |
337| `list-workflows` | List GitHub Actions workflows | `owner`: Repository owner<br>`repo`: Repository name<br>`page`: Page number<br>`perPage`: Items per page | `actions:read` |
338| `list-workflow-runs` | List workflow runs | `owner`: Repository owner<br>`repo`: Repository name<br>`workflow_id`: Workflow ID/filename<br>`branch`: Filter by branch<br>`status`: Filter by status<br>`page`: Page number<br>`perPage`: Items per page | `actions:read` |
339| `trigger-workflow` | Trigger a workflow | `owner`: Repository owner<br>`repo`: Repository name<br>`workflow_id`: Workflow ID/filename<br>`ref`: Git reference<br>`inputs`: Workflow inputs | `actions:write` |
340| `get-license-info` | Get GitHub Enterprise license information | - | **Requires site_admin (Administrator) account** |
341| `get-enterprise-stats` | Get GitHub Enterprise system statistics | - | **Requires site_admin (Administrator) account** |
342 
343> **Note**: For Enterprise-specific tools (`get-license-info` and `get-enterprise-stats`), a user with **site administrator** privileges is required. A Classic Personal Access Token is recommended, as Fine-grained tokens may not support these Enterprise-level permissions.
344 
345## Using the Tools in Cursor
346 
347Once you have set up the MCP server and configured Cursor to connect to it, you can use the GitHub Enterprise tools directly in Cursor's AI chat. Here are some examples:
348 
349### Listing Repositories
350 
351```js
352mcp_github_enterprise_list_repositories(owner="octocat")
353```
354 
355### Getting Repository Information
356 
357```js
358mcp_github_enterprise_get_repository(owner="octocat", repo="hello-world")
359```
360 
361### Listing Pull Requests
362 
363```js
364mcp_github_enterprise_list_pull_requests(owner="octocat", repo="hello-world", state="open")
365```
366 
367### Managing Issues
368 
369```js
370# List issues
371mcp_github_enterprise_list_issues(owner="octocat", repo="hello-world", state="all")
372# Get issue details
373mcp_github_enterprise_get_issue(owner="octocat", repo="hello-world", issue_number=1)
374 
375# Get issue/PR comments
376mcp_github_enterprise_list_issue_comments(owner="octocat", repo="hello-world", issue_number=1)
377 
378 
379# Create a new issue
380mcp_github_enterprise_create_issue(
381  owner="octocat", 
382  repo="hello-world",
383  title="Found a bug",
384  body="Here is a description of the bug",
385  labels=["bug", "important"]
386)
387```
388 
389### Working with Repository Content
390 
391```js
392mcp_github_enterprise_get_content(owner="octocat", repo="hello-world", path="README.md")
393```
394 
395### Repository Management
396 
397```
398# Create a new repository
399mcp_github_enterprise_create_repository(
400  name="new-project",
401  description="This is a new project",
402  private=true,
403  auto_init=true
404)
405 
406# Update repository settings
407mcp_github_enterprise_update_repository(
408  owner="octocat",
409  repo="hello-world",
410  description="Updated description",
411  has_issues=true
412)
413```
414 
415### User Management (Enterprise Only)
416 
417These features are specifically designed for GitHub Enterprise Server environments and require administrative permissions:
418 
419```js
420# List all users in the GitHub Enterprise instance
421mcp_github_enterprise_list_users(filter="active", per_page=100)
422 
423# Get a specific user's details
424mcp_github_enterprise_get_user(username="octocat")
425 
426# Create a new user (Enterprise only)
427mcp_github_enterprise_create_user(
428  login="newuser",
429  email="newuser@example.com",
430  name="New User",
431  company="ACME Inc."
432)
433 
434# Update a user's information (Enterprise only)
435mcp_github_enterprise_update_user(
436  username="octocat",
437  email="updated-email@example.com",
438  location="San Francisco"
439)
440 
441# Suspend a user (Enterprise only)
442mcp_github_enterprise_suspend_user(
443  username="octocat",
444  reason="Violation of terms of service"
445)
446 
447# Unsuspend a user (Enterprise only)
448mcp_github_enterprise_unsuspend_user(username="octocat")
449 
450# List organizations a user belongs to
451mcp_github_enterprise_list_user_orgs(username="octocat")
452```
453 
454## API Improvements
455 
456- Flexible API URL configuration (supports various environment variables and command-line arguments)
457- Enhanced error handling and timeout management
458- User-friendly response formatting and messages
459 
460## Contributing
461 
462Contributions are welcome! Please feel free to submit a Pull Request.
463 
464## License
465 
466ISC
467