You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-3Lines changed: 38 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ automation and interaction capabilities for developers and tools.
16
16
17
17
[](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D)[](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D&quality=insiders)
18
18
19
-
The remote GitHub MCP Server is hosted by GitHub and provides the easiest method for getting up and running. If your MCP host does not support remote MCP servers, don't worry! You can use the [local version of the GitHub MCP Server](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server) instead.
19
+
The remote GitHub MCP Server is hosted by GitHub and provides the easiest method for getting up and running. If your MCP host does not support remote MCP servers, don't worry! You can use the [local version of the GitHub MCP Server](https://github.com/SchulteDev/github_github-mcp-server?tab=readme-ov-file#local-github-mcp-server) instead.
20
20
21
21
## Prerequisites
22
22
@@ -234,8 +234,43 @@ More about using MCP server tools in VS Code's [agent mode documentation](https:
234
234
235
235
### Build from source
236
236
237
-
If you don't have Docker, you can use `go build` to build the binary in the
238
-
`cmd/github-mcp-server` directory, and use the `github-mcp-server stdio` command with the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable set to your token. To specify the output location of the build, use the `-o` flag. You should configure your server to use the built executable as its `command`. For example:
237
+
If you don't have Docker, you have several options:
238
+
239
+
#### Option 1: Run directly from source (Recommended)
240
+
241
+
You can run the server directly from source using `go run`:
242
+
243
+
```bash
244
+
GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> go run github.com/SchulteDev/github_github-mcp-server@latest stdio
// Add global flags that will be shared by all commands
71
-
rootCmd.PersistentFlags().StringSlice("toolsets", github.DefaultTools, "An optional comma separated list of groups of tools to allow, defaults to enabling all")
rootCmd.PersistentFlags().Bool("read-only", false, "Restrict the server to read-only operations")
74
-
rootCmd.PersistentFlags().String("log-file", "", "Path to log file")
75
-
rootCmd.PersistentFlags().Bool("enable-command-logging", false, "When enabled, the server will log all command requests and responses to the log file")
76
-
rootCmd.PersistentFlags().Bool("export-translations", false, "Save translations to a JSON file")
77
-
rootCmd.PersistentFlags().String("gh-host", "", "Specify the GitHub hostname (for GitHub Enterprise etc.)")
70
+
RootCmd.PersistentFlags().StringSlice("toolsets", github.DefaultTools, "An optional comma separated list of groups of tools to allow, defaults to enabling all")
RootCmd.PersistentFlags().Bool("read-only", false, "Restrict the server to read-only operations")
73
+
RootCmd.PersistentFlags().String("log-file", "", "Path to log file")
74
+
RootCmd.PersistentFlags().Bool("enable-command-logging", false, "When enabled, the server will log all command requests and responses to the log file")
75
+
RootCmd.PersistentFlags().Bool("export-translations", false, "Save translations to a JSON file")
76
+
RootCmd.PersistentFlags().String("gh-host", "", "Specify the GitHub hostname (for GitHub Enterprise etc.)")
0 commit comments