Skip to content

Commit ea4c429

Browse files
authored
Revise GitHub PAT instructions and permissions section
1 parent 527bafd commit ea4c429

File tree

1 file changed

+4
-64
lines changed

1 file changed

+4
-64
lines changed

README.md

Lines changed: 4 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -103,67 +103,8 @@ See [Remote Server Documentation](/docs/remote-server.md) on how to pass additio
103103

104104
1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
105105
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`.
106-
3. [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
107-
Each tool requires specific permissions to function. See the [Required Token Permissions](#required-token-permissions) section below for details.
108-
109-
## Required Token Permissions
110-
111-
Each tool requires specific GitHub Personal Access Token permissions to function. Below are the required permissions for each tool category:
112-
113-
### Users
114-
- **get_me**
115-
- Required permissions:
116-
- `read:user` - Read access to profile info
117-
118-
### Issues
119-
- **get_issue**, **get_issue_comments**, **list_issues**
120-
- Required permissions:
121-
- `repo` - Full control of private repositories (for private repos)
122-
- `public_repo` - Access public repositories (for public repos)
123-
124-
- **create_issue**, **add_issue_comment**, **update_issue**
125-
- Required permissions:
126-
- `repo` - Full control of private repositories (for private repos)
127-
- `public_repo` - Access public repositories (for public repos)
128-
- `write:discussion` - Write access to repository discussions (if using discussions)
129-
130-
### Pull Requests
131-
- **get_pull_request**, **list_pull_requests**, **get_pull_request_files**, **get_pull_request_status**
132-
- Required permissions:
133-
- `repo` - Full control of private repositories (for private repos)
134-
- `public_repo` - Access public repositories (for public repos)
135-
136-
- **merge_pull_request**, **update_pull_request_branch**, **create_pull_request**, **update_pull_request**
137-
- Required permissions:
138-
- `repo` - Full control of private repositories (for private repos)
139-
- `public_repo` - Access public repositories (for public repos)
140-
- `write:discussion` - Write access to repository discussions (if using discussions)
141-
142-
### Repositories
143-
- **get_file_contents**, **search_repositories**, **list_commits**
144-
- Required permissions:
145-
- `repo` - Full control of private repositories (for private repos)
146-
- `public_repo` - Access public repositories (for public repos)
147-
148-
- **create_or_update_file**, **push_files**, **create_repository**, **fork_repository**, **create_branch**
149-
- Required permissions:
150-
- `repo` - Full control of private repositories (for private repos)
151-
- `public_repo` - Access public repositories (for public repos)
152-
- `delete_repo` - Delete repositories (if needed)
153-
154-
### Search
155-
- **search_code**, **search_users**
156-
- Required permissions:
157-
- No special permissions required for public data
158-
- `repo` - Required for searching private repositories
159-
160-
### Code Scanning
161-
- **get_code_scanning_alert**, **list_code_scanning_alerts**
162-
- Required permissions:
163-
- `security_events` - Read and write security events
164-
- `repo` - Full control of private repositories (for private repos)
165-
166-
Note: For organization repositories, additional organization-specific permissions may be required.
106+
3. Lastly you will need to [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
107+
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)).
167108

168109
<details><summary><b>Handling PATs Securely</b></summary>
169110

@@ -887,7 +828,7 @@ The following sets of tools are available (all are on by default):
887828
- `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional)
888829
- `repo`: Repository name (string, required)
889830
- `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)
890-
831+
891832
- **get_latest_release** - Get latest release
892833
- `owner`: Repository owner (string, required)
893834
- `repo`: Repository name (string, required)
@@ -910,7 +851,7 @@ The following sets of tools are available (all are on by default):
910851
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
911852
- `repo`: Repository name (string, required)
912853
- `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional)
913-
854+
914855
- **list_releases** - List releases
915856
- `owner`: Repository owner (string, required)
916857
- `page`: Page number for pagination (min 1) (number, optional)
@@ -1145,4 +1086,3 @@ The exported Go API of this module should currently be considered unstable, and
11451086
## License
11461087

11471088
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
1148-

0 commit comments

Comments
 (0)