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
+17-1Lines changed: 17 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,8 @@ automation and interaction capabilities for developers and tools.
15
15
## Prerequisites
16
16
17
17
1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
18
-
2.[Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
18
+
2. Once Docker is installed, you will also need to ensure Docker is running.
19
+
3. Lastly you will need to [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
19
20
The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).
20
21
21
22
@@ -287,6 +288,17 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
-**create_or_update_file** - Create or update a single file in a repository
@@ -442,6 +454,10 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
442
454
-`prNumber`: Pull request number (string, required)
443
455
-`path`: File or directory path (string, optional)
444
456
457
+
## Library Usage
458
+
459
+
The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.
460
+
445
461
## License
446
462
447
463
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
rootCmd.PersistentFlags().Bool("enable-command-logging", false, "When enabled, the server will log all command requests and responses to the log file")
71
67
rootCmd.PersistentFlags().Bool("export-translations", false, "Save translations to a JSON file")
72
68
rootCmd.PersistentFlags().String("gh-host", "", "Specify the GitHub hostname (for GitHub Enterprise etc.)")
0 commit comments