- Notifications
You must be signed in to change notification settings - Fork1.2k
collapse docs from readme#580
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -426,12 +426,18 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
## Tools | ||
<details> | ||
<summary>Context</summary> | ||
- **get_me** - Get details of the authenticated user | ||
- No parameters required | ||
</details> | ||
<details> | ||
<summary>Issues</summary> | ||
- **get_issue** - Gets the contents of an issue within a repository | ||
@@ -499,8 +505,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `issueNumber`: Issue number (number, required) | ||
- _Note_: This tool can help with creating a Pull Request with source code changes to resolve the issue. More information can be found at [GitHub Copilot documentation](https://docs.github.com/en/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot) | ||
</details> | ||
<details> | ||
<summary>Pull Requests</summary> | ||
- **get_pull_request** - Get details of a specific pull request | ||
@@ -667,7 +676,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `pullNumber`: Pull request number (number, required) | ||
- _Note_: Currently, this tool will only work for github.com | ||
</details> | ||
<details> | ||
<summary>Repositories</summary> | ||
- **create_or_update_file** - Create or update a single file in a repository | ||
- `owner`: Repository owner (string, required) | ||
@@ -761,7 +774,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `page`: Page number (number, optional) | ||
- `perPage`: Results per page (number, optional) | ||
</details> | ||
<details> | ||
<summary>Users</summary> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. User tools ( Copilot uses AI. Check for mistakes. | ||
- **search_users** - Search for GitHub users | ||
- `q`: Search query (string, required) | ||
@@ -770,7 +787,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `page`: Page number (number, optional) | ||
- `perPage`: Results per page (number, optional) | ||
</details> | ||
<details> | ||
<summary>Actions</summary> | ||
- **list_workflows** - List workflows in a repository | ||
@@ -874,7 +895,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `repo`: Repository name (string, required) | ||
- `run_id`: Workflow run ID (number, required) | ||
</details> | ||
<details> | ||
<summary>Code Scanning</summary> | ||
- **get_code_scanning_alert** - Get a code scanning alert | ||
@@ -890,7 +915,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `severity`: Alert severity (string, optional) | ||
- `tool_name`: The name of the tool used for code scanning (string, optional) | ||
</details> | ||
<details> | ||
<summary>Secret Scanning</summary> | ||
- **get_secret_scanning_alert** - Get a secret scanning alert | ||
@@ -905,7 +934,11 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `secret_type`: The secret types to be filtered for in a comma-separated list (string, optional) | ||
- `resolution`: The resolution status (string, optional) | ||
</details> | ||
<details> | ||
<summary>Notifications</summary> | ||
- **list_notifications** – List notifications for a GitHub user | ||
- `filter`: Filter to apply to the response (`default`, `include_read_notifications`, `only_participating`) | ||
@@ -937,9 +970,13 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `repo`: The name of the repository (string, required) | ||
- `action`: Action to perform: `ignore`, `watch`, or `delete` (string, required) | ||
</details> | ||
## Resources | ||
<details> | ||
<summary>Repository Content</summary> | ||
- **Get Repository Content** | ||
Retrieves the content of a repository at a specific path. | ||
@@ -990,6 +1027,8 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description | ||
- `prNumber`: Pull request number (string, required) | ||
- `path`: File or directory path (string, optional) | ||
</details> | ||
## Library Usage | ||
The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable. | ||