Skip to content

Commit 22e58fb

Browse files
committed
update doc
1 parent 1c4cb29 commit 22e58fb

File tree

1 file changed

+135
-9
lines changed

1 file changed

+135
-9
lines changed

README.md

Lines changed: 135 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,141 @@ and set it as the GITHUB_PERSONAL_ACCESS_TOKEN environment variable.
1010

1111
## Tools
1212

13-
1. `get_me`
14-
- Return information about the authenticated user
15-
2. `get_issue`
16-
- Get the contents of an issue within a repository.
17-
- Inputs
18-
- `owner` (string): Repository owner
19-
- `repo` (string): Repository name
20-
- `issue_number` (number): Issue number to retrieve
21-
- Returns: Github Issue object & details
13+
### Users
14+
- **get_me** - Get details of the authenticated user
15+
- No parameters required
16+
17+
### Issues
18+
- **get_issue** - Gets the contents of an issue within a repository
19+
- `owner`: Repository owner (string, required)
20+
- `repo`: Repository name (string, required)
21+
- `issue_number`: Issue number (number, required)
22+
23+
- **add_issue_comment** - Add a comment to an issue
24+
- `owner`: Repository owner (string, required)
25+
- `repo`: Repository name (string, required)
26+
- `issue_number`: Issue number (number, required)
27+
- `body`: Comment text (string, required)
28+
29+
- **search_issues** - Search for issues and pull requests
30+
- `query`: Search query (string, required)
31+
- `sort`: Sort field (string, optional)
32+
- `order`: Sort order (string, optional)
33+
- `page`: Page number (number, optional)
34+
- `per_page`: Results per page (number, optional)
35+
36+
### Pull Requests
37+
- **get_pull_request** - Get details of a specific pull request
38+
- `owner`: Repository owner (string, required)
39+
- `repo`: Repository name (string, required)
40+
- `pull_number`: Pull request number (number, required)
41+
42+
- **list_pull_requests** - List and filter repository pull requests
43+
- `owner`: Repository owner (string, required)
44+
- `repo`: Repository name (string, required)
45+
- `state`: PR state (string, optional)
46+
- `sort`: Sort field (string, optional)
47+
- `direction`: Sort direction (string, optional)
48+
- `per_page`: Results per page (number, optional)
49+
- `page`: Page number (number, optional)
50+
51+
- **merge_pull_request** - Merge a pull request
52+
- `owner`: Repository owner (string, required)
53+
- `repo`: Repository name (string, required)
54+
- `pull_number`: Pull request number (number, required)
55+
- `commit_title`: Title for the merge commit (string, optional)
56+
- `commit_message`: Message for the merge commit (string, optional)
57+
- `merge_method`: Merge method (string, optional)
58+
59+
- **get_pull_request_files** - Get the list of files changed in a pull request
60+
- `owner`: Repository owner (string, required)
61+
- `repo`: Repository name (string, required)
62+
- `pull_number`: Pull request number (number, required)
63+
64+
- **get_pull_request_status** - Get the combined status of all status checks for a pull request
65+
- `owner`: Repository owner (string, required)
66+
- `repo`: Repository name (string, required)
67+
- `pull_number`: Pull request number (number, required)
68+
69+
- **update_pull_request_branch** - Update a pull request branch with the latest changes from the base branch
70+
- `owner`: Repository owner (string, required)
71+
- `repo`: Repository name (string, required)
72+
- `pull_number`: Pull request number (number, required)
73+
- `expected_head_sha`: The expected SHA of the pull request's HEAD ref (string, optional)
74+
75+
- **get_pull_request_comments** - Get the review comments on a pull request
76+
- `owner`: Repository owner (string, required)
77+
- `repo`: Repository name (string, required)
78+
- `pull_number`: Pull request number (number, required)
79+
80+
- **get_pull_request_reviews** - Get the reviews on a pull request
81+
- `owner`: Repository owner (string, required)
82+
- `repo`: Repository name (string, required)
83+
- `pull_number`: Pull request number (number, required)
84+
85+
### Repositories
86+
- **create_or_update_file** - Create or update a single file in a repository
87+
- `owner`: Repository owner (string, required)
88+
- `repo`: Repository name (string, required)
89+
- `path`: File path (string, required)
90+
- `message`: Commit message (string, required)
91+
- `content`: File content (string, required)
92+
- `branch`: Branch name (string, optional)
93+
- `sha`: File SHA if updating (string, optional)
94+
95+
- **search_repositories** - Search for GitHub repositories
96+
- `query`: Search query (string, required)
97+
- `sort`: Sort field (string, optional)
98+
- `order`: Sort order (string, optional)
99+
- `page`: Page number (number, optional)
100+
- `per_page`: Results per page (number, optional)
101+
102+
- **create_repository** - Create a new GitHub repository
103+
- `name`: Repository name (string, required)
104+
- `description`: Repository description (string, optional)
105+
- `private`: Whether the repository is private (boolean, optional)
106+
- `auto_init`: Auto-initialize with README (boolean, optional)
107+
- `gitignore_template`: Gitignore template name (string, optional)
108+
109+
- **get_file_contents** - Get contents of a file or directory
110+
- `owner`: Repository owner (string, required)
111+
- `repo`: Repository name (string, required)
112+
- `path`: File path (string, required)
113+
- `ref`: Git reference (string, optional)
114+
115+
- **fork_repository** - Fork a repository
116+
- `owner`: Repository owner (string, required)
117+
- `repo`: Repository name (string, required)
118+
- `organization`: Target organization name (string, optional)
119+
120+
- **create_branch** - Create a new branch
121+
- `owner`: Repository owner (string, required)
122+
- `repo`: Repository name (string, required)
123+
- `branch`: New branch name (string, required)
124+
- `sha`: SHA to create branch from (string, required)
125+
126+
- **list_commits** - Gets commits of a branch in a repository
127+
- `owner`: Repository owner (string, required)
128+
- `repo`: Repository name (string, required)
129+
- `sha`: Branch name, tag, or commit SHA (string, optional)
130+
- `path`: Only commits containing this file path (string, optional)
131+
- `page`: Page number (number, optional)
132+
- `per_page`: Results per page (number, optional)
133+
134+
### Search
135+
- **search_code** - Search for code across GitHub repositories
136+
- `query`: Search query (string, required)
137+
- `sort`: Sort field (string, optional)
138+
- `order`: Sort order (string, optional)
139+
- `page`: Page number (number, optional)
140+
- `per_page`: Results per page (number, optional)
141+
142+
- **search_users** - Search for GitHub users
143+
- `query`: Search query (string, required)
144+
- `sort`: Sort field (string, optional)
145+
- `order`: Sort order (string, optional)
146+
- `page`: Page number (number, optional)
147+
- `per_page`: Results per page (number, optional)
22148

23149
## Standard input/output server
24150

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy