Skip to content

Commit bd1a2b7

Browse files
committed
update all relative paths to be absolute
1 parent 7d4a4a6 commit bd1a2b7

File tree

12 files changed

+52
-52
lines changed

12 files changed

+52
-52
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Hi there! We're thrilled that you'd like to contribute to this project. Your hel
88

99
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
1010

11-
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
11+
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/github/github-mcp-server/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
1212

1313
## What we're looking for
1414

@@ -39,8 +39,8 @@ These are one time installations required to be able to test your changes locall
3939
- Run linter: `script/lint`
4040
- Update snapshots and run tests: `UPDATE_TOOLSNAPS=true go test ./...`
4141
- Update readme documentation: `script/generate-docs`
42-
- If renaming a tool, add a deprecation alias (see [Tool Renaming Guide](docs/tool-renaming.md))
43-
- For toolset and icon configuration, see [Toolsets and Icons Guide](docs/toolsets-and-icons.md)
42+
- If renaming a tool, add a deprecation alias (see [Tool Renaming Guide](https://github.com/github/github-mcp-server/blob/main/docs/tool-renaming.md))
43+
- For toolset and icon configuration, see [Toolsets and Icons Guide](https://github.com/github/github-mcp-server/blob/main/docs/toolsets-and-icons.md)
4444
6. Push to your fork and [submit a pull request][pr] targeting the `main` branch
4545
7. Pat yourself on the back and wait for your pull request to be reviewed and merged.
4646

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,20 +80,20 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
8080
</table>
8181

8282
### Install in other MCP hosts
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 Desktop and Claude Code CLI
85-
- **[Codex](/docs/installation-guides/install-codex.md)** - Installation guide for Open AI Codex
86-
- **[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
87-
- **[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
88-
- **[Rovo Dev CLI](/docs/installation-guides/install-rovo-dev-cli.md)** - Installation guide for Rovo Dev CLI
83+
- **[GitHub Copilot in other IDEs](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
84+
- **[Claude Applications](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
85+
- **[Codex](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-codex.md)** - Installation guide for Open AI Codex
86+
- **[Cursor](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
87+
- **[Windsurf](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
88+
- **[Rovo Dev CLI](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-rovo-dev-cli.md)** - Installation guide for Rovo Dev CLI
8989

9090
> **Note:** Each MCP host application needs to configure a GitHub App or OAuth App to support remote access via OAuth. Any host application that supports remote MCP servers should support the remote GitHub server with PAT authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info.
9191
9292
### Configuration
9393

9494
#### Toolset configuration
9595

96-
See [Remote Server Documentation](docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.
96+
See [Remote Server Documentation](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.
9797

9898
When no toolsets are specified, [default toolsets](#default-toolset) are used.
9999

@@ -297,13 +297,13 @@ Optionally, you can add a similar example (i.e. without the mcp key) to a file c
297297

298298
For other MCP host applications, please refer to our installation guides:
299299

300-
- **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
301-
- **[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
302-
- **[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
303-
- **[Google Gemini CLI](docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
304-
- **[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
300+
- **[GitHub Copilot in other IDEs](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
301+
- **[Claude Code & Claude Desktop](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
302+
- **[Cursor](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
303+
- **[Google Gemini CLI](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
304+
- **[Windsurf](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
305305

306-
For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides)**.
306+
For a complete overview of all installation options, see our **[Installation Guides Index](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides)**.
307307

308308
> **Note:** Any host application that supports local MCP servers should be able to access the local GitHub MCP server. However, the specific configuration process, syntax and stability of the integration will vary by host application. While many may follow a similar format to the examples above, this is not guaranteed. Please refer to your host application's documentation for the correct MCP configuration syntax and setup process.
309309
@@ -336,7 +336,7 @@ _Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also
336336

337337
When no toolsets are specified, [default toolsets](#default-toolset) are used.
338338

339-
> **Looking for examples?** See the [Server Configuration Guide](./docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
339+
> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/blob/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
340340
341341
#### Specifying Toolsets
342342

@@ -386,7 +386,7 @@ You can also configure specific tools using the `--tools` flag. Tools can be use
386386
- Tools, toolsets, and dynamic toolsets can all be used together
387387
- Read-only mode takes priority: write tools are skipped if `--read-only` is set, even if explicitly requested via `--tools`
388388
- Tool names must match exactly (e.g., `get_file_contents`, not `getFileContents`). Invalid tool names will cause the server to fail at startup with an error message
389-
- When tools are renamed, old names are preserved as aliases for backward compatibility. See [Deprecated Tool Aliases](docs/deprecated-tool-aliases.md) for details.
389+
- When tools are renamed, old names are preserved as aliases for backward compatibility. See [Deprecated Tool Aliases](https://github.com/github/github-mcp-server/blob/main/docs/deprecated-tool-aliases.md) for details.
390390

391391
### Using Toolsets With Docker
392392

@@ -1513,4 +1513,4 @@ The exported Go API of this module should currently be considered unstable, and
15131513

15141514
## License
15151515

1516-
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
1516+
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](https://github.com/github/github-mcp-server/blob/main/LICENSE) for the full terms.

docs/installation-guides/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
This directory contains detailed installation instructions for the GitHub MCP Server across different host applications and IDEs. Choose the guide that matches your development environment.
44

55
## Installation Guides by Host Application
6-
- **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
7-
- **[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE
8-
- **[Claude Applications](install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
9-
- **[Cursor](install-cursor.md)** - Installation guide for Cursor IDE
10-
- **[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI
11-
- **[OpenAI Codex](install-codex.md)** - Installation guide for OpenAI Codex
12-
- **[Windsurf](install-windsurf.md)** - Installation guide for Windsurf IDE
6+
- **[GitHub Copilot in other IDEs](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
7+
- **[Antigravity](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-antigravity.md)** - Installation for Google Antigravity IDE
8+
- **[Claude Applications](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
9+
- **[Cursor](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
10+
- **[Google Gemini CLI](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
11+
- **[OpenAI Codex](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-codex.md)** - Installation guide for OpenAI Codex
12+
- **[Windsurf](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
1313

1414
## Support by Host Application
1515

@@ -88,7 +88,7 @@ If you encounter issues:
8888
2. Verify your GitHub PAT has the required permissions
8989
3. Ensure Docker is running (for local installations)
9090
4. Review your host application's logs for error messages
91-
5. Consult the main [README.md](README.md) for additional configuration options
91+
5. Consult the main [README.md](https://github.com/github/github-mcp-server/blob/main/README.md) for additional configuration options
9292

9393
## Configuration Options
9494

docs/installation-guides/install-antigravity.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Once installed, you'll have access to tools like:
128128
- `get_file_contents` - Read file content
129129
- And many more...
130130

131-
For a complete list of available tools and features, see the [main README](../../README.md).
131+
For a complete list of available tools and features, see the [main README](https://github.com/github/github-mcp-server/blob/main/README.md).
132132

133133
## Differences from Other IDEs
134134

@@ -138,6 +138,6 @@ For a complete list of available tools and features, see the [main README](../..
138138

139139
## Next Steps
140140

141-
- Explore the [Server Configuration Guide](../server-configuration.md) for advanced options
142-
- Check out [toolsets documentation](../../README.md#available-toolsets) to customize available tools
143-
- See the [Remote Server Documentation](../remote-server.md) for more details
141+
- Explore the [Server Configuration Guide](https://github.com/github/github-mcp-server/blob/main/docs/server-configuration.md) for advanced options
142+
- Check out [toolsets documentation](https://github.com/github/github-mcp-server/blob/main/README.md#available-toolsets) to customize available tools
143+
- See the [Remote Server Documentation](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) for more details

docs/installation-guides/install-codex.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ After starting Codex (CLI or IDE):
5656

5757
## Usage
5858

59-
After setup, Codex can interact with GitHub directly. It will use the default tool set automatically but can be [configured](../../README.md#default-toolset). Try these example prompts:
59+
After setup, Codex can interact with GitHub directly. It will use the default tool set automatically but can be [configured](https://github.com/github/github-mcp-server/blob/main/README.md#default-toolset). Try these example prompts:
6060

6161
**Repository Operations:**
6262
- "List my GitHub repositories"
@@ -109,4 +109,4 @@ Use the principle of least privilege: add scopes only when a tool request fails
109109
- Remote server URL: `https://api.githubcopilot.com/mcp/`
110110
- Release binaries: [GitHub Releases](https://github.com/github/github-mcp-server/releases)
111111
- OpenAI Codex MCP docs: https://developers.openai.com/codex/mcp
112-
- Main project README: [Advanced configuration options](../../README.md)
112+
- Main project README: [Advanced configuration options](https://github.com/github/github-mcp-server/blob/main/README.md)

docs/installation-guides/install-gemini-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ MCP servers for Gemini CLI are configured in its settings JSON under an `mcpServ
2828

2929
After securely storing your PAT, you can add the GitHub MCP server configuration to your settings file using one of the methods below. You may need to restart the Gemini CLI for changes to take effect.
3030

31-
> **Note:** For the most up-to-date configuration options, see the [main README.md](../../README.md).
31+
> **Note:** For the most up-to-date configuration options, see the [main README.md](https://github.com/github/github-mcp-server/blob/main/README.md).
3232
3333
### Method 1: Gemini Extension (Recommended)
3434

docs/installation-guides/install-other-copilot-ides.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install GitHub MCP Server in Copilot IDEs
22

3-
Quick setup guide for the GitHub MCP server in GitHub Copilot across different IDEs. For VS Code instructions, refer to the [VS Code install guide in the README](/README.md#installation-in-vs-code)
3+
Quick setup guide for the GitHub MCP server in GitHub Copilot across different IDEs. For VS Code instructions, refer to the [VS Code install guide in the README](https://github.com/github/github-mcp-server/blob/main/README.md#installation-in-vs-code)
44

55
### Requirements:
66
- **GitHub Copilot License**: Any Copilot plan (Free, Pro, Pro+, Business, Enterprise) for Copilot access

docs/remote-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The Remote GitHub MCP server has optional headers equivalent to the Local server
6868
- Equivalent to `GITHUB_LOCKDOWN_MODE` env var for Local server.
6969
- If this header is empty, "false", "f", "no", "n", "0", or "off" (ignoring whitespace and case), it will be interpreted as false. All other values are interpreted as true.
7070

71-
> **Looking for examples?** See the [Server Configuration Guide](./server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
71+
> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/blob/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
7272
7373
Example:
7474

@@ -88,7 +88,7 @@ Example:
8888

8989
The Remote GitHub MCP server supports the following URL path patterns:
9090

91-
- `/` - Default toolset (see ["default" toolset](../README.md#default-toolset))
91+
- `/` - Default toolset (see ["default" toolset](https://github.com/github/github-mcp-server/blob/main/README.md#default-toolset))
9292
- `/readonly` - Default toolset in read-only mode
9393
- `/x/all` - All available toolsets
9494
- `/x/all/readonly` - All available toolsets in read-only mode

docs/scope-filtering.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ With OAuth, the remote server can dynamically request additional scopes as neede
2424

2525
## OAuth Scope Challenges (Remote Server)
2626

27-
When using the [remote MCP server](./remote-server.md) with OAuth authentication, the server uses a different approach called **scope challenges**. Instead of hiding tools upfront, all tools are available, and the server requests additional scopes on-demand when you try to use a tool that requires them.
27+
When using the [remote MCP server](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) with OAuth authentication, the server uses a different approach called **scope challenges**. Instead of hiding tools upfront, all tools are available, and the server requests additional scopes on-demand when you try to use a tool that requires them.
2828

2929
**How it works:**
3030
1. You attempt to use a tool (e.g., creating an issue)
@@ -58,7 +58,7 @@ Some scopes implicitly include others:
5858

5959
This means if your token has `repo`, tools requiring `security_events` will also be available.
6060

61-
Each tool in the [README](../README.md#tools) lists its required and accepted OAuth scopes.
61+
Each tool in the [README](https://github.com/github/github-mcp-server/blob/main/README.md#tools) lists its required and accepted OAuth scopes.
6262

6363
## Public Repository Access
6464

@@ -98,6 +98,6 @@ WARN: failed to fetch token scopes, continuing without scope filtering
9898
9999
## Related Documentation
100100

101-
- [Server Configuration Guide](./server-configuration.md)
101+
- [Server Configuration Guide](https://github.com/github/github-mcp-server/blob/main/docs/server-configuration.md)
102102
- [GitHub PAT Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
103103
- [OAuth Scopes Reference](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)

0 commit comments

Comments
 (0)