-
Notifications
You must be signed in to change notification settings - Fork 2.7k
docs: update github mcp config #3433
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2f4344e
update steps
dianed-square 4803921
final steps
dianed-square 2065d20
Update documentation/docs/mcp/github-mcp.md
dianed-square 2643bae
Update documentation/docs/mcp/github-mcp.md
dianed-square 351c15f
add get token step for Desktop config
dianed-square d62dfd0
remove deprecated npx warning
dianed-square File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,66 +10,294 @@ import CLIExtensionInstructions from '@site/src/components/CLIExtensionInstructi | |
|
|
||
| <YouTubeShortEmbed videoUrl="https://www.youtube.com/embed/TbmQDv3SQOE" /> | ||
|
|
||
| This tutorial covers how to add the [GitHub MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/github) as a Goose extension to enable file operations, repository management, search functionality, and more. | ||
| This tutorial covers how to add the [GitHub MCP Server](https://github.com/github/github-mcp-server) as a Goose extension to enable file operations, repository management, search functionality, and more. | ||
|
|
||
| :::tip TLDR | ||
| <Tabs groupId="interface"> | ||
| <TabItem value="ui" label="Goose Desktop" default> | ||
| [Launch the installer](goose://extension?cmd=npx&arg=-y&arg=%40modelcontextprotocol%2Fserver-github&id=github&name=GitHub&description=GitHub%20API&env=GITHUB_PERSONAL_ACCESS_TOKEN%3DGitHub%20Personal%20Access%20Token) | ||
| Use `Add custom extension` in Settings → Extensions to add a `Streamable HTTP` extension type with: | ||
| </TabItem> | ||
| <TabItem value="cli" label="Goose CLI"> | ||
| **Command** | ||
| ```sh | ||
| npx -y @modelcontextprotocol/server-github | ||
| ``` | ||
| Use `goose configure` to add a `Remote Extension (Streaming HTTP)` extension type with: | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| **Environment Variable** | ||
| **Endpoint URL** | ||
| ``` | ||
| https://api.githubcopilot.com/mcp/ | ||
| ``` | ||
| GITHUB_PERSONAL_ACCESS_TOKEN: <YOUR_TOKEN> | ||
| **Custom Request Header** | ||
| ``` | ||
| Authorization: Bearer <YOUR_GITHUB_PERSONAL_ACCESS_TOKEN> | ||
| ``` | ||
| ::: | ||
|
|
||
| ## Configuration | ||
|
|
||
| :::info | ||
| Note that you'll need [Node.js](https://nodejs.org/) installed on your system to run this command, as it uses `npx`. | ||
| ::: | ||
| These steps configure the Remote MCP Server. For other deployment options, see the [official GitHub MCP Server documentation](https://github.com/github/github-mcp-server). | ||
|
|
||
| <Tabs groupId="interface"> | ||
| <TabItem value="ui" label="Goose Desktop" default> | ||
| 1. [Launch the installer](goose://extension?cmd=npx&arg=-y&arg=%40modelcontextprotocol%2Fserver-github&id=github&name=GitHub&description=GitHub%20API&env=GITHUB_PERSONAL_ACCESS_TOKEN%3DGitHub%20Personal%20Access%20Token) | ||
| 2. Press `Yes` to confirm the installation | ||
| 3. Obtain a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) and paste it in | ||
| 4. Click `Save Configuration` | ||
| 5. Scroll to the top and click `Exit` from the upper left corner | ||
| 1. Obtain a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) | ||
| 2. Click the gear icon `⚙️` in the top right corner | ||
| 3. Click `Advanced settings` | ||
| 4. Under `Extensions`, click `Add custom extension` | ||
| 5. On the `Add custom extension` modal, enter the following: | ||
| - **Extension Name**: GitHub | ||
| - **Type**: Streamable HTTP | ||
| - **Endpoint**: `https://api.githubcopilot.com/mcp/` | ||
| - **Request Headers**: | ||
| - **Header name**: `Authorization` | ||
| - **Value**: `Bearer <YOUR_GITHUB_PERSONAL_ACCESS_TOKEN>` | ||
| 6. Click `+ Add` to save the header | ||
| 7. Click `Add Extension` to save the extension | ||
|
|
||
| </TabItem> | ||
| <TabItem value="cli" label="Goose CLI"> | ||
| 1. Run the `configure` command: | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I didn't create a new component for the streamable flow, but plan to do it later |
||
| ```sh | ||
| goose configure | ||
| ``` | ||
|
|
||
| 2. Choose to add a `Remote Extension (Streaming HTTP)` | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◆ What type of extension would you like to add? | ||
| │ ○ Built-in Extension | ||
| │ ○ Command-line Extension (Run a local command or script) | ||
| │ ○ Remote Extension (SSE) | ||
| // highlight-start | ||
| │ ● Remote Extension (Streaming HTTP) | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 3. Give your extension a name | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| // highlight-start | ||
| ◆ What would you like to call this extension? | ||
| │ github | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 4. Enter the Streaming HTTP endpoint URI | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| ◇ What would you like to call this extension? | ||
| │ github | ||
| │ | ||
| // highlight-start | ||
| ◆ What is the Streaming HTTP endpoint URI? | ||
| │ https://api.githubcopilot.com/mcp/ | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 5. Set the timeout | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| ◇ What would you like to call this extension? | ||
| │ github | ||
| │ | ||
| ◇ What is the Streaming HTTP endpoint URI? | ||
| │ https://api.githubcopilot.com/mcp/ | ||
| │ | ||
| // highlight-start | ||
| ◆ Please set the timeout for this tool (in secs): | ||
| │ 300 | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 6. Choose whether to add a description | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| ◇ What would you like to call this extension? | ||
| │ github | ||
| │ | ||
| ◇ What is the Streaming HTTP endpoint URI? | ||
| │ https://api.githubcopilot.com/mcp/ | ||
| │ | ||
| ◇ Please set the timeout for this tool (in secs): | ||
| │ 300 | ||
| │ | ||
| // highlight-start | ||
| ◆ Would you like to add a description? | ||
| │ No | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 7. Add a custom header for authentication | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| ◇ What would you like to call this extension? | ||
| │ github | ||
| │ | ||
| ◇ What is the Streaming HTTP endpoint URI? | ||
| │ https://api.githubcopilot.com/mcp/ | ||
| │ | ||
| ◇ Please set the timeout for this tool (in secs): | ||
| │ 300 | ||
| │ | ||
| ◇ Would you like to add a description? | ||
| │ No | ||
| │ | ||
| // highlight-start | ||
| ◆ Would you like to add custom headers? | ||
| │ Yes | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 8. Enter the Authorization header | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| ◇ What would you like to call this extension? | ||
| │ github | ||
| │ | ||
| ◇ What is the Streaming HTTP endpoint URI? | ||
| │ https://api.githubcopilot.com/mcp/ | ||
| │ | ||
| ◇ Please set the timeout for this tool (in secs): | ||
| │ 300 | ||
| │ | ||
| ◇ Would you like to add a description? | ||
| │ No | ||
| │ | ||
| ◇ Would you like to add custom headers? | ||
| │ Yes | ||
| │ | ||
| // highlight-start | ||
| ◆ Header name: | ||
| │ Authorization | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| <CLIExtensionInstructions | ||
| name="github" | ||
| command="npx -y @modelcontextprotocol/server-github" | ||
| timeout={300} | ||
| envVars={[ | ||
| { key: "GITHUB_TOKEN", value: "••••••••••••••••" } | ||
| ]} | ||
| infoNote={ | ||
| <> | ||
| When creating your access token, you can specify the repositories and granular permissions you'd like Goose to have access to.{" "} | ||
| <a | ||
| href="https://github.com/settings/personal-access-tokens" | ||
| target="_blank" | ||
| rel="noopener noreferrer" | ||
| > | ||
| Create one here | ||
| </a>. | ||
| </> | ||
| } | ||
| /> | ||
| 9. Enter your [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| ◇ What would you like to call this extension? | ||
| │ github | ||
| │ | ||
| ◇ What is the Streaming HTTP endpoint URI? | ||
| │ https://api.githubcopilot.com/mcp/ | ||
| │ | ||
| ◇ Please set the timeout for this tool (in secs): | ||
| │ 300 | ||
| │ | ||
| ◇ Would you like to add a description? | ||
| │ No | ||
| │ | ||
| ◇ Would you like to add custom headers? | ||
| │ Yes | ||
| │ | ||
| ◇ Header name: | ||
| │ Authorization | ||
| │ | ||
| // highlight-start | ||
| ◆ Header value: | ||
| │ Bearer ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 10. Choose not to add another header | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Remote Extension (Streaming HTTP) | ||
| │ | ||
| ◇ What would you like to call this extension? | ||
| │ github | ||
| │ | ||
| ◇ What is the Streaming HTTP endpoint URI? | ||
| │ https://api.githubcopilot.com/mcp/ | ||
| │ | ||
| ◇ Please set the timeout for this tool (in secs): | ||
| │ 100 | ||
| │ | ||
| ◇ Would you like to add a description? | ||
| │ No | ||
| │ | ||
| ◇ Would you like to add custom headers? | ||
| │ Yes | ||
| │ | ||
| ◇ Header name: | ||
| │ Authorization | ||
| │ | ||
| ◇ Header value: | ||
| │ Bearer ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
| │ | ||
| // highlight-start | ||
| ◆ Add another header? | ||
| │ No | ||
| │ | ||
| // highlight-end | ||
| └ Added github extension | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
|
||
| ## Example Usage | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wasn't able to create a smooth install link experience for a streamable-http type, will open an issue to add deeplink support