Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Reorganize README, add dedicated install guides, include policies and governance info for the github server#695

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
tonytrg merged 16 commits intogithub:mainfromD1M1TR10S:main
Jul 18, 2025

Conversation

D1M1TR10S
Copy link
Contributor

This PR improves the docs structure and clarity for the GitHub MCP Server, and add a policies and governance doc for info on control mechanisms.

Changes

  • Reorganized README for better clarity and navigation
  • Created dedicated installation guides for non-VS Code host applications:
    • /docs/installation-guides/install-other-copilot-ides.md - JetBrains, Visual Studio, Eclipse, Xcode
    • /docs/installation-guides/install-claude.md - Claude Web, Desktop, and Code CLI
    • /docs/installation-guides/install-cursor.md - Cursor IDE
    • /docs/installation-guides/install-windsurf.md - Windsurf IDE
  • Updated contribution guidelines to clarify approval criteria for different types of requests
  • Added policies and governance documentation at/docs/policies-and-governance.md

Impact

These changes make it easier for users to find installation instructions for their specific host application, understand how requests are prioritized, and governance policies.

@CopilotCopilotAI review requested due to automatic review settingsJuly 17, 2025 18:38
@D1M1TR10SD1M1TR10S requested a review froma team as acode ownerJuly 17, 2025 18:38
Copy link
Contributor

@CopilotCopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

This PR reorganizes and improves the documentation structure for the GitHub MCP Server by creating dedicated installation guides for different host applications and adding comprehensive policies and governance information. The restructuring makes it easier for users to find setup instructions specific to their development environment.

Key changes:

  • Restructured README with clearer organization and focused installation sections
  • Created dedicated installation guides for major host applications (Claude, Cursor, Windsurf, Copilot IDEs)
  • Added comprehensive policies and governance documentation covering enterprise controls and security
  • Updated contribution guidelines with clearer approval criteria

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

FileDescription
docs/policies-and-governance.mdNew comprehensive documentation covering enterprise control mechanisms, authentication methods, and governance policies
docs/installation-guides/New directory with dedicated installation guides for different host applications
README.mdRestructured for better clarity with streamlined installation sections and references to new guides
CONTRIBUTING.mdAdded section clarifying approval criteria and what types of contributions are prioritized
Comments suppressed due to low confidence (1)

docs/policies-and-governance.md:186

  • The terminology is inconsistent and confusing. It should be 'Prefer fine-grained PATs to classic PATs' for clarity.
* Prefer fine-grained PATs to PATs (Classic)


---

##JetBrains IDEs
Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@phanthaiduong22 Do you mind confirming all the installation steps for Copilot in JetBrains, Eclipse and Xcode?

phanthaiduong22 reacted with thumbs up emoji

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@jdneo@testforstephen for Eclipse/Xcode installation steps

@toby
Copy link
Member

Awesome!! I'd say rename/docs/installation-guides/installation-guides.md to/docs/installation-guides/README.md so that it shows up automatically when a user views that directory on GitHub. You should also squash all the commits into a single commit, but other than that it looks great!

D1M1TR10S reacted with thumbs up emoji

- Reorganized README for clarity and navigation- Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more- Clarified contribution guidelines and approval criteria- Added policies and governance documentation
@D1M1TR10SD1M1TR10S removed the request for review fromphanthaiduong22July 18, 2025 03:22
Copy link

@jdneojdneo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM for the Eclipse part. Thank you@D1M1TR10S.

Comment on lines +55 to +56
```bash
claude mcp add-json github'{"command": "docker", "args": ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"], "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat"}}'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I tested the cli with remote mcp and it works well, but I am happy to add the remote configuration as a seperate pr

@tonytrgtonytrg merged commit1a74e6d intogithub:mainJul 18, 2025
10 checks passed
##Support by Host Application

| Host Application| Local GitHub MCP Support| Remote GitHub MCP Support| Prerequisites| Difficulty|
|-----------------|---------------|----------------|---------------|------------|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

i love this table

LuluBeatson added a commit that referenced this pull requestJul 22, 2025
* Create 'add sub-issue' tool* Fix hardcoded API host* Create 'list sub-issues' tool* Create 'remove sub-issue' tool* Fix Test_GetIssue mock data - add missing User fieldThe assertion was already checking User.Login but the mock was incomplete* Create 'reprioritize sub-issue' tool* fixes* use go github pck to add sub-issues* Update to use go github package* update description* update to use go github v73* lint, docs* refactor: tests to use go-github-mock* add toolsnaps* make RemoveSubIssue use NewGitHubAPIErrorResponse, update docstring* Always include SHA in get_file_contents responses (#676)* fix: Add SHA to get_file_contents while preserving MCP behavior (#595)Enhance get_file_contents to include SHA information without changingthe existing MCP server response format.Changes:- Add Contents API call to retrieve SHA before fetching raw content- Include SHA in resourceURI (repo://owner/repo/sha/{SHA}/contents/path)- Add SHA to success messages- Update tests to verify SHA inclusion- Maintain original behavior: text files return raw text, binaries return base64This preserves backward compatibility while providing SHA informationfor better file versioning support.Closes#595* fix: Improve error handling for Contents API responseEnsure response body is properly closed even when an error occurs by movingthe defer statement before the error check. This prevents potential resourceleaks when the Contents API returns an error with a non-nil response.Changes:- Move defer respContents.Body.Close() before error checking- Rename errContents to err for consistency- Add nil check for respContents before attempting to close bodyThis follows Go best practices for handling HTTP responses and preventspotential goroutine/memory leaks.* revert changes to resource URI* use GraphQL API to get file SHA* refactor: mock GQL client instead of getFileSHA function to follow conventions* lint* revert GraphQL---------Co-authored-by: LuluBeatson <lulubeatson@github.com>* Reorganize README, add dedicated install guides, include policies and governance info for the github server (#695)* Refactor README and add host installation guides, governance docs- Reorganized README for clarity and navigation- Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more- Clarified contribution guidelines and approval criteria- Added policies and governance documentation* Update README.md* Update README with configuration section for remote GitHub MCP Server* Update MCP access policy description in READMERemoving coding agent from the policy note, as the GitHub server is unaffected by this policy* Update configuration steps for GitHub Copilot in JetBrains IDEs......to reflect changes in accessing settings and configuring MCP.* Update install-other-copilot-ides.md* Update Eclipse MCP support version and configuration steps......for GitHub Copilot plugin in installation guide.* Update docs/installation-guides/install-cursor.md* Update docs/installation-guides/install-windsurf.md* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg---------Co-authored-by: Tony Truong <tonytrg@github.com>* fix: shorten long tool name for adding pr review comments (#697)* shorten tool name* update function name to match tool name* adjust wording of descriptions* Update installation guide for GitHub MCP Server (#699)* Update installation guide for GitHub MCP ServerRemoved reference to GitHub.com in the installation guide. The GitHub server is available to Coding Agent by default, without installation needed.* Rename section to 'Install in Other MCP Hosts'Updating title for consistency and adding a link to the "other Copilot IDEs" install guide.* Revise installation guide for Cursor MCP setupUpdated installation guide for Cursor with steps clarified, remote server installation, and one-click install deeplinks to open Cursor and add the github server to the config file.* fix: make mcpcurl support "integer" type (#688)- FYI:https://json-schema.org/understanding-json-schema/reference/numeric#integer* Added installation instructions for mcpcurl (#719)* Added installation instructions for mcpcurl* Update cmd/mcpcurl/README.mdCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>---------Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* Add pagination support to GraphQL-based tools (#683)* initial pagination for `ListDiscussions`* redo category id var cast* add GraphQL pagination support for discussion comments and categories* remove pageinfo returns* fix out ref for linter* update docs* move to unified pagination for consensus on params* update docs* refactor pagination handling* update docs* linter fix* conv rest to gql params for safe lint* add nolint* add error handling for perPage value in ToGraphQLParams* refactor pagination error handling* unified params for rest andn graphql and rennamed to be uniform for golang* add 'after' for pagination* update docs* Update pkg/github/discussions.goCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* Update pkg/github/discussions.goCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* Update pkg/github/discussions_test.goCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* update default page size const* reduce default pagination size from 100 to 30 in discussion tests* update pagination for reverse and total* update pagination to remove from discussions* updated README* improve the `ToGraphQLParams` function---------Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* shorten param descriptions* fix: resp nil check in error handling in RemoveSubIssue function---------Co-authored-by: LuluBeatson <lulubeatson@github.com>Co-authored-by: tommaso-moro <tommaso-moro@github.com>
Comment on lines +22 to +34
1. Go to**Tools** →**Options** →**GitHub** →**Copilot** →**MCP Servers**
2. Add this configuration:
```json
{
"servers": {
"github": {
"url":"https://api.githubcopilot.com/mcp/",
"authorization_token":"Bearer YOUR_GITHUB_PAT"
}
}
}
```
3. Restart Visual Studio
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Was this AI hallucinated docs? Every step of this is wrong.

Batdill and AIA70805 reacted with thumbs up emoji
nickytonline pushed a commit to nickytonline/github-mcp-http that referenced this pull requestOct 4, 2025
… governance info for the github server (github#695)* Refactor README and add host installation guides, governance docs- Reorganized README for clarity and navigation- Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more- Clarified contribution guidelines and approval criteria- Added policies and governance documentation* Update README.md* Update README with configuration section for remote GitHub MCP Server* Update MCP access policy description in READMERemoving coding agent from the policy note, as the GitHub server is unaffected by this policy* Update configuration steps for GitHub Copilot in JetBrains IDEs......to reflect changes in accessing settings and configuring MCP.* Update install-other-copilot-ides.md* Update Eclipse MCP support version and configuration steps......for GitHub Copilot plugin in installation guide.* Update docs/installation-guides/install-cursor.md* Update docs/installation-guides/install-windsurf.md* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg---------Co-authored-by: Tony Truong <tonytrg@github.com>
nickytonline pushed a commit to nickytonline/github-mcp-http that referenced this pull requestOct 4, 2025
* Create 'add sub-issue' tool* Fix hardcoded API host* Create 'list sub-issues' tool* Create 'remove sub-issue' tool* Fix Test_GetIssue mock data - add missing User fieldThe assertion was already checking User.Login but the mock was incomplete* Create 'reprioritize sub-issue' tool* fixes* use go github pck to add sub-issues* Update to use go github package* update description* update to use go github v73* lint, docs* refactor: tests to use go-github-mock* add toolsnaps* make RemoveSubIssue use NewGitHubAPIErrorResponse, update docstring* Always include SHA in get_file_contents responses (github#676)* fix: Add SHA to get_file_contents while preserving MCP behavior (github#595)Enhance get_file_contents to include SHA information without changingthe existing MCP server response format.Changes:- Add Contents API call to retrieve SHA before fetching raw content- Include SHA in resourceURI (repo://owner/repo/sha/{SHA}/contents/path)- Add SHA to success messages- Update tests to verify SHA inclusion- Maintain original behavior: text files return raw text, binaries return base64This preserves backward compatibility while providing SHA informationfor better file versioning support.Closesgithub#595* fix: Improve error handling for Contents API responseEnsure response body is properly closed even when an error occurs by movingthe defer statement before the error check. This prevents potential resourceleaks when the Contents API returns an error with a non-nil response.Changes:- Move defer respContents.Body.Close() before error checking- Rename errContents to err for consistency- Add nil check for respContents before attempting to close bodyThis follows Go best practices for handling HTTP responses and preventspotential goroutine/memory leaks.* revert changes to resource URI* use GraphQL API to get file SHA* refactor: mock GQL client instead of getFileSHA function to follow conventions* lint* revert GraphQL---------Co-authored-by: LuluBeatson <lulubeatson@github.com>* Reorganize README, add dedicated install guides, include policies and governance info for the github server (github#695)* Refactor README and add host installation guides, governance docs- Reorganized README for clarity and navigation- Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more- Clarified contribution guidelines and approval criteria- Added policies and governance documentation* Update README.md* Update README with configuration section for remote GitHub MCP Server* Update MCP access policy description in READMERemoving coding agent from the policy note, as the GitHub server is unaffected by this policy* Update configuration steps for GitHub Copilot in JetBrains IDEs......to reflect changes in accessing settings and configuring MCP.* Update install-other-copilot-ides.md* Update Eclipse MCP support version and configuration steps......for GitHub Copilot plugin in installation guide.* Update docs/installation-guides/install-cursor.md* Update docs/installation-guides/install-windsurf.md* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg* Apply suggestion from@tonytrg---------Co-authored-by: Tony Truong <tonytrg@github.com>* fix: shorten long tool name for adding pr review comments (github#697)* shorten tool name* update function name to match tool name* adjust wording of descriptions* Update installation guide for GitHub MCP Server (github#699)* Update installation guide for GitHub MCP ServerRemoved reference to GitHub.com in the installation guide. The GitHub server is available to Coding Agent by default, without installation needed.* Rename section to 'Install in Other MCP Hosts'Updating title for consistency and adding a link to the "other Copilot IDEs" install guide.* Revise installation guide for Cursor MCP setupUpdated installation guide for Cursor with steps clarified, remote server installation, and one-click install deeplinks to open Cursor and add the github server to the config file.* fix: make mcpcurl support "integer" type (github#688)- FYI:https://json-schema.org/understanding-json-schema/reference/numeric#integer* Added installation instructions for mcpcurl (github#719)* Added installation instructions for mcpcurl* Update cmd/mcpcurl/README.mdCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>---------Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* Add pagination support to GraphQL-based tools (github#683)* initial pagination for `ListDiscussions`* redo category id var cast* add GraphQL pagination support for discussion comments and categories* remove pageinfo returns* fix out ref for linter* update docs* move to unified pagination for consensus on params* update docs* refactor pagination handling* update docs* linter fix* conv rest to gql params for safe lint* add nolint* add error handling for perPage value in ToGraphQLParams* refactor pagination error handling* unified params for rest andn graphql and rennamed to be uniform for golang* add 'after' for pagination* update docs* Update pkg/github/discussions.goCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* Update pkg/github/discussions.goCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* Update pkg/github/discussions_test.goCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* update default page size const* reduce default pagination size from 100 to 30 in discussion tests* update pagination for reverse and total* update pagination to remove from discussions* updated README* improve the `ToGraphQLParams` function---------Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>* shorten param descriptions* fix: resp nil check in error handling in RemoveSubIssue function---------Co-authored-by: LuluBeatson <lulubeatson@github.com>Co-authored-by: tommaso-moro <tommaso-moro@github.com>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@AArnottAArnottAArnott left review comments

@IrynaKulakovaIrynaKulakovaIrynaKulakova left review comments

Copilot code reviewCopilotCopilot left review comments

@tonytrgtonytrgtonytrg approved these changes

+2 more reviewers

@EskibearEskibearEskibear left review comments

@jdneojdneojdneo approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

7 participants
@D1M1TR10S@toby@AArnott@Eskibear@jdneo@tonytrg@IrynaKulakova
[8]ページ先頭
©2009-2025 Movatter.jp