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/copilot-instructions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ This is the **GitHub MCP Server**, a Model Context Protocol (MCP) server that co
9
9
-**Type:** MCP server application with CLI interface
10
10
-**Primary Package:** github-mcp-server (stdio MCP server - **this is the main focus**)
11
11
-**Secondary Package:** mcpcurl (testing utility - don't break it, but not the priority)
12
-
-**Framework:** Uses mark3labs/mcp-go for MCP protocol, google/go-github for GitHub API
12
+
-**Framework:** Uses modelcontextprotocol/go-sdk for MCP protocol, google/go-github for GitHub API
13
13
-**Size:**~60MB repository, 70 Go files
14
14
-**Library Usage:** This repository is also used as a library by the remote server. Functions that could be called by other repositories should be exported (capitalized), even if not required internally. Preserve existing export patterns.
Copy file name to clipboardExpand all lines: README.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,11 +95,13 @@ See [Remote Server Documentation](docs/remote-server.md) for full details on rem
95
95
96
96
When no toolsets are specified, [default toolsets](#default-toolset) are used.
97
97
98
-
#### Enterprise Cloud with data residency (ghe.com)
98
+
#### GitHub Enterprise
99
+
100
+
##### GitHub Enterprise Cloud with data residency (ghe.com)
99
101
100
102
GitHub Enterprise Cloud can also make use of the remote server.
101
103
102
-
Example for `https://octocorp.ghe.com`:
104
+
Example for `https://octocorp.ghe.com` with GitHub PAT token:
103
105
```
104
106
{
105
107
...
@@ -114,6 +116,10 @@ Example for `https://octocorp.ghe.com`:
114
116
}
115
117
```
116
118
119
+
> **Note:** When using OAuth with GitHub Enterprise with VS Code and GitHub Copilot, you also need to configure your VS Code settings to point to your GitHub Enterprise instance - see [Authenticate from VS Code](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom)
120
+
121
+
##### GitHub Enterprise Server
122
+
117
123
GitHub Enterprise Server does not support remote server hosting. Please refer to [GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)](#github-enterprise-server-and-enterprise-cloud-with-data-residency-ghecom) from the local server configuration.
118
124
119
125
---
@@ -719,8 +725,8 @@ The following sets of tools are available:
719
725
720
726
-**issue_read** - Get issue details
721
727
-`issue_number`: The number of the issue (number, required)
722
-
-`method`: The read operation to perform on a single issue.
723
-
Options are:
728
+
-`method`: The read operation to perform on a single issue.
729
+
Options are:
724
730
1. get - Get details of a specific issue.
725
731
2. get_comments - Get issue comments.
726
732
3. get_sub_issues - Get sub-issues of the issue.
@@ -738,8 +744,8 @@ Options are:
738
744
-`issue_number`: Issue number to update (number, optional)
739
745
-`labels`: Labels to apply to this issue (string[], optional)
740
746
-`method`: Write operation to perform on a single issue.
741
-
Options are:
742
-
- 'create' - creates a new issue.
747
+
Options are:
748
+
- 'create' - creates a new issue.
743
749
- 'update' - updates an existing issue.
744
750
(string, required)
745
751
-`milestone`: Milestone number (number, optional)
@@ -819,7 +825,7 @@ Options are:
819
825
<summary>Notifications</summary>
820
826
821
827
-**dismiss_notification** - Dismiss notification
822
-
-`state`: The new state of the notification (read/done) (string, optional)
828
+
-`state`: The new state of the notification (read/done) (string, required)
823
829
-`threadID`: The ID of the notification thread (string, required)
824
830
825
831
-**get_notification_details** - Get notification details
0 commit comments