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: .github/pull_request_template.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,13 @@ Fixes #
33
33
-[ ] Auth / permissions considered
34
34
-[ ] Data exposure, filtering, or token/size limits considered
35
35
36
+
## Tool renaming
37
+
-[ ] I am renaming tools as part of this PR (e.g. a part of a consolidation effort)
38
+
-[ ] I have added the new tool aliases in `deprecated_tool_aliases.go`
39
+
-[ ] I am not renaming tools as part of this PR
40
+
41
+
Note: if you're renaming tools, you *must* add the tool aliases. For more information on how to do so, please refer to the [official docs](https://github.com/github/github-mcp-server/blob/main/docs/tool-renaming.md).
42
+
36
43
## Lint & tests
37
44
<!-- Check what you ran. If not run, explain briefly. -->
Copy file name to clipboardExpand all lines: README.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,7 +81,8 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
81
81
82
82
### Install in other MCP hosts
83
83
-**[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
84
-
-**[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
84
+
-**[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
85
+
-**[Codex](/docs/installation-guides/install-codex.md)** - Installation guide for Open AI Codex
85
86
-**[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
86
87
-**[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
87
88
@@ -131,7 +132,7 @@ GitHub Enterprise Server does not support remote server hosting. Please refer to
131
132
### Prerequisites
132
133
133
134
1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
134
-
2. Once Docker is installed, you will also need to ensure Docker is running. The image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`.
135
+
2. Once Docker is installed, you will also need to ensure Docker is running. The Docker image is available at `ghcr.io/github/github-mcp-server`. The image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`.
135
136
3. Lastly you will need to [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
136
137
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)).
137
138
@@ -393,7 +394,7 @@ When using Docker, you can pass the toolsets as environment variables:
0 commit comments