Skip to content

Commit 387a47e

Browse files
committed
Added installation instructions for Mise.
1 parent 2cece8f commit 387a47e

File tree

1 file changed

+40
-21
lines changed

1 file changed

+40
-21
lines changed

Diff for: README.md

+40-21
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,28 @@ The MCP server can use many of the GitHub APIs, so enable the permissions that y
2121

2222
## Installation
2323

24+
### Usage with Claude Desktop
25+
26+
```json
27+
{
28+
"mcpServers": {
29+
"github": {
30+
"command": "docker",
31+
"args": [
32+
"run",
33+
"-i",
34+
"--rm",
35+
"-e",
36+
"GITHUB_PERSONAL_ACCESS_TOKEN",
37+
"ghcr.io/github/github-mcp-server"
38+
],
39+
"env": {
40+
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
41+
}
42+
}
43+
}
44+
```
45+
2446
### Usage with VS Code
2547

2648
For quick installation, use one of the one-click install buttons at the top of this README.
@@ -64,28 +86,25 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace
6486

6587
More about using MCP server tools in VS Code's [agent mode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
6688

67-
### Usage with Claude Desktop
89+
### Using Mise for Installation
6890

69-
```json
70-
{
71-
"mcpServers": {
72-
"github": {
73-
"command": "docker",
74-
"args": [
75-
"run",
76-
"-i",
77-
"--rm",
78-
"-e",
79-
"GITHUB_PERSONAL_ACCESS_TOKEN",
80-
"ghcr.io/github/github-mcp-server"
81-
],
82-
"env": {
83-
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
84-
}
85-
}
86-
}
87-
}
88-
```
91+
To quickly configure and deploy the GitHub MCP Server in your environment, you can use **[Mise](https://mise.jdx.dev)**, a deployment and configuration tool optimized for developer workflows.
92+
93+
Here’s how to get started:
94+
95+
1. Install `mise` by following the installation instructions at [https://mise.jdx.dev](https://mise.jdx.dev).
96+
2. Use the following command to deploy the GitHub MCP Server configuration:
97+
98+
```bash
99+
mise deploy github-mcp-server --token=<YOUR_PERSONAL_ACCESS_TOKEN> --use-docker
100+
```
101+
102+
- Replace `<YOUR_PERSONAL_ACCESS_TOKEN>` with your GitHub personal access token.
103+
- Use `--use-docker` to run the server via Docker.
104+
105+
3. Confirm that the server is running using `mise status`.
106+
107+
For more details, see [Mise's official documentation](https://mise.jdx.dev/docs).
89108

90109
### Build from source
91110

0 commit comments

Comments
 (0)