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: README.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,6 +219,23 @@ docker run -i --rm \
219
219
ghcr.io/github/github-mcp-server
220
220
```
221
221
222
+
##Read-Only Mode
223
+
224
+
To run the server in read-only mode, you can use the`--read-only` flag. This will only offer read-only tools, preventing any modifications to repositories, issues, pull requests, etc.
225
+
226
+
```bash
227
+
./github-mcp-server --read-only
228
+
```
229
+
230
+
When using Docker, you can pass the read-only mode as an environment variable:
231
+
232
+
```bash
233
+
docker run -i --rm \
234
+
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
235
+
-e GITHUB_READ_ONLY=1 \
236
+
ghcr.io/github/github-mcp-server
237
+
```
238
+
222
239
##GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
223
240
224
241
The flag`--gh-host` and the environment variable`GITHUB_HOST` can be used to set