8000 update readme · github/github-mcp-server@76a26f0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 76a26f0

Browse files
update readme
1 parent 22321f0 commit 76a26f0

File tree

1 file changed

+63
-13
lines changed

1 file changed

+63
-13
lines changed

README.md

Lines changed: 63 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,59 @@ and set it as the GITHUB_PERSONAL_ACCESS_TOKEN environment variable.
181181
- `state`: Alert state (string, optional)
182182
- `severity`: Alert severity (string, optional)
183183

184+
## Resources
185+
186+
### Repository Content
187+
188+
- **Get Repository Content**
189+
Retrieves the content of a repository at a specific path.
190+
191+
- **Template**: `repo://{owner}/{repo}/contents{/path*}`
192+
- **Parameters**:
193+
- `owner`: Repository owner (string, required)
194+
- `repo`: Repository name (string, required)
195+
- `path`: File or directory path (string, optional)
196+
197+
- **Get Repository Content for a Specific Branch**
198+
Retrieves the content of a repository at a specific path for a given branch.
199+
200+
- **Template**: `repo://{owner}/{repo}/refs/heads/{branch}/contents{/path*}`
201+
- **Parameters**:
202+
- `owner`: Repository owner (string, required)
203+
- `repo`: Repository name (string, required)
204+
- `branch`: Branch name (string, required)
205+
- `path`: File or directory path (string, optional)
206+
207+
- **Get Repository Content for a Specific Commit**
208+
Retrieves the content of a repository at a specific path for a given commit.
209+
210+
- **Template**: `repo://{owner}/{repo}/sha/{sha}/contents{/path*}`
211+
- **Parameters**:
212+
- `owner`: Repository owner (string, required)
213+
- `repo`: Repository name (string, required)
214+
- `sha`: Commit SHA (string, required)
215+
- `path`: File or directory path (string, optional)
216+
217+
- **Get Repository Content for a Specific Tag**
218+
Retrieves the content of a repository at a specific path for a given tag.
219+
220+
- **Template**: `repo://{owner}/{repo}/refs/tags/{tag}/contents{/path*}`
221+
- **Parameters**:
222+
- `owner`: Repository owner (string, required)
223+
- `repo`: Repository name (string, required)
224+
- `tag`: Tag name (string, required)
225+
- `path`: File or directory path (string, optional)
226+
227+
- **Get Repository Content for a Specific Pull Request**
228+
Retrieves the content of a repository at a specific path for a given pull request.
229+
230+
- **Template**: `repo://{owner}/{repo}/refs/pull/{pr_number}/head/contents{/path*}`
231+
- **Parameters**:
232+
- `owner`: Repository owner (string, required)
233+
- `repo`: Repository name (string, required)
234+
- `pr_number`: Pull request number (number, required)
235+
- `path`: File or directory path (string, optional)
236+
184237
## Standard input/output server
185238

186239
```sh
@@ -216,7 +269,7 @@ GitHub MCP Server running on stdio
216269
217270
## Testing on VS Code Insiders
218271
219-
First of all, install `github-mcp-server` with:
272+
First of all, install `github-mcp-server` with:
220273
221274
```bash
222275
go install ./cmd/github-mcp-server
@@ -231,18 +284,16 @@ Go to settings, find the MCP related settings, and set them to:
231284
232285
```json
233286
{
234-
"mcp": {
235-
"inputs": [],
236-
"servers": {
237-
"mcp-github-server": {
238-
"command": "path-to-your/github-mcp-server",
239-
"args": [
240-
"stdio"
241-
],
242-
"env": {}
243-
}
244-
}
287+
"mcp": {
288+
"inputs": [],
289+
"servers": {
290+
"mcp-github-server": {
291+
"command": "path-to-your/github-mcp-server",
292+
"args": ["stdio"],
293+
"env": {}
294+
}
245295
}
296+
}
246297
}
247298
```
248299
@@ -255,7 +306,6 @@ Try something like the following prompt to verify that it works:
255306
I'd like to know more about my GitHub profile.
256307
```
257308
258-
259309
## TODO
260310
261311
Lots of things!

0 commit comments

Comments
 (0)
0