diff --git a/README.md b/README.md
index 0936749f..27d4bccd 100644
--- a/README.md
+++ b/README.md
@@ -426,12 +426,18 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
## Tools
-### Users
+
+
+Context
- **get_me** - Get details of the authenticated user
- No parameters required
-### Issues
+
+
+
+
+Issues
- **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)
+
-### Pull Requests
+
+
+Pull Requests
- **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
-### Repositories
+
+
+
+
+Repositories
- **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)
-### Users
+
+
+
+
+Users
- **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)
-### Actions
+
+
+
+
+Actions
- **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)
-### Code Scanning
+
+
+
+
+Code Scanning
- **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)
-### Secret Scanning
+
+
+
+
+Secret Scanning
- **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)
-### Notifications
+
+
+
+
+Notifications
- **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)
+
+
## Resources
-### Repository Content
+
+
+Repository Content
- **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)
+
+
## 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.