Skip to content

Commit 53c3a25

Browse files
committed
Update docs
1 parent eda6b28 commit 53c3a25

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1264,7 +1264,7 @@ docker run -i --rm \
12641264

12651265
## Lockdown Mode
12661266

1267-
Lockdown mode limits the content that the server will surface from public repositories. When enabled, requests that fetch issue details will return an error if the issue was created by someone who does not have push access to the repository. Private repositories are unaffected, and collaborators can still access their own issues.
1267+
Lockdown mode limits the content that the server will surface from public repositories. When enabled, the server checks whether the author of each item has push access to the repository. Private repositories are unaffected, and collaborators keep full access to their own content.
12681268

12691269
```bash
12701270
./github-mcp-server --lockdown-mode
@@ -1279,7 +1279,20 @@ docker run -i --rm \
12791279
ghcr.io/github/github-mcp-server
12801280
```
12811281

1282-
At the moment lockdown mode applies to the issue read toolset, but it is designed to extend to additional data surfaces over time.
1282+
The behavior of lockdown mode depends on the tool invoked.
1283+
1284+
Following tools will return an error when the author lacks the push access:
1285+
1286+
- `issue_read:get`
1287+
- `pull_request_read:get`
1288+
1289+
Following tools will filter out content from users lacking the push access:
1290+
1291+
- `issue_read:get_comments`
1292+
- `issue_read:get_sub_issues`
1293+
- `pull_request_read:get_comments`
1294+
- `pull_request_read:get_review_comments`
1295+
- `pull_request_read:get_reviews`
12831296

12841297
## i18n / Overriding Descriptions
12851298

0 commit comments

Comments
 (0)