From f4a8d471fdc16a7ec08bffe291aa64cd06b59384 Mon Sep 17 00:00:00 2001 From: Sam Morrow Date: Wed, 17 Dec 2025 10:33:49 +0100 Subject: [PATCH] fix: remove redundant icons from individual tools Icons are kept on section headers and toolsets table only - having the same icon on every tool within a section was visually noisy and redundant. --- README.md | 190 ++++++++++++------------- cmd/github-mcp-server/generate_docs.go | 8 +- 2 files changed, 97 insertions(+), 101 deletions(-) diff --git a/README.md b/README.md index 6042cae7..4071874b 100644 --- a/README.md +++ b/README.md @@ -490,22 +490,22 @@ The following sets of tools are available: workflow Actions -- workflow **cancel_workflow_run** - Cancel workflow run +- **cancel_workflow_run** - Cancel workflow run - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **delete_workflow_run_logs** - Delete workflow logs +- **delete_workflow_run_logs** - Delete workflow logs - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **download_workflow_run_artifact** - Download workflow artifact +- **download_workflow_run_artifact** - Download workflow artifact - `artifact_id`: The unique identifier of the artifact (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- workflow **get_job_logs** - Get job logs +- **get_job_logs** - Get job logs - `failed_only`: When true, gets logs for all failed jobs in run_id (boolean, optional) - `job_id`: The unique identifier of the workflow job (required for single job logs) (number, optional) - `owner`: Repository owner (string, required) @@ -514,22 +514,22 @@ The following sets of tools are available: - `run_id`: Workflow run ID (required when using failed_only) (number, optional) - `tail_lines`: Number of lines to return from the end of the log (number, optional) -- workflow **get_workflow_run** - Get workflow run +- **get_workflow_run** - Get workflow run - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **get_workflow_run_logs** - Get workflow run logs +- **get_workflow_run_logs** - Get workflow run logs - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **get_workflow_run_usage** - Get workflow usage +- **get_workflow_run_usage** - Get workflow usage - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **list_workflow_jobs** - List workflow jobs +- **list_workflow_jobs** - List workflow jobs - `filter`: Filters jobs by their completed_at timestamp (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -537,14 +537,14 @@ The following sets of tools are available: - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **list_workflow_run_artifacts** - List workflow artifacts +- **list_workflow_run_artifacts** - List workflow artifacts - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **list_workflow_runs** - List workflow runs +- **list_workflow_runs** - List workflow runs - `actor`: Returns someone's workflow runs. Use the login for the user who created the workflow run. (string, optional) - `branch`: Returns workflow runs associated with a branch. Use the name of the branch. (string, optional) - `event`: Returns workflow runs for a specific event type (string, optional) @@ -555,23 +555,23 @@ The following sets of tools are available: - `status`: Returns workflow runs with the check run status (string, optional) - `workflow_id`: The workflow ID or workflow file name (string, required) -- workflow **list_workflows** - List workflows +- **list_workflows** - List workflows - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) -- workflow **rerun_failed_jobs** - Rerun failed jobs +- **rerun_failed_jobs** - Rerun failed jobs - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **rerun_workflow_run** - Rerun workflow run +- **rerun_workflow_run** - Rerun workflow run - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `run_id`: The unique identifier of the workflow run (number, required) -- workflow **run_workflow** - Run workflow +- **run_workflow** - Run workflow - `inputs`: Inputs the workflow accepts (object, optional) - `owner`: Repository owner (string, required) - `ref`: The git reference for the workflow. The reference can be a branch or tag name. (string, required) @@ -584,12 +584,12 @@ The following sets of tools are available: codescan Code Security -- codescan **get_code_scanning_alert** - Get code scanning alert +- **get_code_scanning_alert** - Get code scanning alert - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) -- codescan **list_code_scanning_alerts** - List code scanning alerts +- **list_code_scanning_alerts** - List code scanning alerts - `owner`: The owner of the repository. (string, required) - `ref`: The Git reference for the results you want to list. (string, optional) - `repo`: The name of the repository. (string, required) @@ -603,14 +603,14 @@ The following sets of tools are available: person Context -- person **get_me** - Get my user profile +- **get_me** - Get my user profile - No parameters required -- person **get_team_members** - Get team members +- **get_team_members** - Get team members - `org`: Organization login (owner) that contains the team. (string, required) - `team_slug`: Team slug (string, required) -- person **get_teams** - Get teams +- **get_teams** - Get teams - `user`: Username to get teams for. If not provided, uses the authenticated user. (string, optional) @@ -619,12 +619,12 @@ The following sets of tools are available: dependabot Dependabot -- dependabot **get_dependabot_alert** - Get dependabot alert +- **get_dependabot_alert** - Get dependabot alert - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) -- dependabot **list_dependabot_alerts** - List dependabot alerts +- **list_dependabot_alerts** - List dependabot alerts - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) - `severity`: Filter dependabot alerts by severity (string, optional) @@ -636,23 +636,23 @@ The following sets of tools are available: comment-discussion Discussions -- comment-discussion **get_discussion** - Get discussion +- **get_discussion** - Get discussion - `discussionNumber`: Discussion Number (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- comment-discussion **get_discussion_comments** - Get discussion comments +- **get_discussion_comments** - Get discussion comments - `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional) - `discussionNumber`: Discussion Number (number, required) - `owner`: Repository owner (string, required) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) -- comment-discussion **list_discussion_categories** - List discussion categories +- **list_discussion_categories** - List discussion categories - `owner`: Repository owner (string, required) - `repo`: Repository name. If not provided, discussion categories will be queried at the organisation level. (string, optional) -- comment-discussion **list_discussions** - List discussions +- **list_discussions** - List discussions - `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional) - `category`: Optional filter by discussion category ID. If provided, only discussions with this category are listed. (string, optional) - `direction`: Order direction. (string, optional) @@ -667,22 +667,22 @@ The following sets of tools are available: logo-gist Gists -- logo-gist **create_gist** - Create Gist +- **create_gist** - Create Gist - `content`: Content for simple single-file gist creation (string, required) - `description`: Description of the gist (string, optional) - `filename`: Filename for simple single-file gist creation (string, required) - `public`: Whether the gist is public (boolean, optional) -- logo-gist **get_gist** - Get Gist Content +- **get_gist** - Get Gist Content - `gist_id`: The ID of the gist (string, required) -- logo-gist **list_gists** - List Gists +- **list_gists** - List Gists - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `since`: Only gists updated after this time (ISO 8601 timestamp) (string, optional) - `username`: GitHub username (omit for authenticated user's gists) (string, optional) -- logo-gist **update_gist** - Update Gist +- **update_gist** - Update Gist - `content`: Content for the file (string, required) - `description`: Updated description of the gist (string, optional) - `filename`: Filename to update or create (string, required) @@ -694,7 +694,7 @@ The following sets of tools are available: git-branch Git -- git-branch **get_repository_tree** - Get repository tree +- **get_repository_tree** - Get repository tree - `owner`: Repository owner (username or organization) (string, required) - `path_filter`: Optional path prefix to filter the tree results (e.g., 'src/' to only show files in the src directory) (string, optional) - `recursive`: Setting this parameter to true returns the objects or subtrees referenced by the tree. Default is false (boolean, optional) @@ -707,23 +707,23 @@ The following sets of tools are available: issue-opened Issues -- issue-opened **add_issue_comment** - Add comment to issue +- **add_issue_comment** - Add comment to issue - `body`: Comment content (string, required) - `issue_number`: Issue number to comment on (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- issue-opened **assign_copilot_to_issue** - Assign Copilot to issue +- **assign_copilot_to_issue** - Assign Copilot to issue - `issueNumber`: Issue number (number, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- issue-opened **get_label** - Get a specific label from a repository. +- **get_label** - Get a specific label from a repository. - `name`: Label name. (string, required) - `owner`: Repository owner (username or organization name) (string, required) - `repo`: Repository name (string, required) -- issue-opened **issue_read** - Get issue details +- **issue_read** - Get issue details - `issue_number`: The number of the issue (number, required) - `method`: The read operation to perform on a single issue. Options are: @@ -737,7 +737,7 @@ The following sets of tools are available: - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: The name of the repository (string, required) -- issue-opened **issue_write** - Create or update issue. +- **issue_write** - Create or update issue. - `assignees`: Usernames to assign to this issue (string[], optional) - `body`: Issue body content (string, optional) - `duplicate_of`: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional) @@ -756,10 +756,10 @@ The following sets of tools are available: - `title`: Issue title (string, optional) - `type`: Type of this issue. Only use if the repository has issue types configured. Use list_issue_types tool to get valid type values for the organization. If the repository doesn't support issue types, omit this parameter. (string, optional) -- issue-opened **list_issue_types** - List available issue types +- **list_issue_types** - List available issue types - `owner`: The organization owner of the repository (string, required) -- issue-opened **list_issues** - List issues +- **list_issues** - List issues - `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional) - `direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional) - `labels`: Filter by labels (string[], optional) @@ -770,7 +770,7 @@ The following sets of tools are available: - `since`: Filter by date (ISO 8601 timestamp) (string, optional) - `state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional) -- issue-opened **search_issues** - Search issues +- **search_issues** - Search issues - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) @@ -779,7 +779,7 @@ The following sets of tools are available: - `repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) -- issue-opened **sub_issue_write** - Change sub-issue +- **sub_issue_write** - Change sub-issue - `after_id`: The ID of the sub-issue to be prioritized after (either after_id OR before_id should be specified) (number, optional) - `before_id`: The ID of the sub-issue to be prioritized before (either after_id OR before_id should be specified) (number, optional) - `issue_number`: The number of the parent issue (number, required) @@ -800,12 +800,12 @@ The following sets of tools are available: tag Labels -- tag **get_label** - Get a specific label from a repository. +- **get_label** - Get a specific label from a repository. - `name`: Label name. (string, required) - `owner`: Repository owner (username or organization name) (string, required) - `repo`: Repository name (string, required) -- tag **label_write** - Write operations on repository labels. +- **label_write** - Write operations on repository labels. - `color`: Label color as 6-character hex code without '#' prefix (e.g., 'f29513'). Required for 'create', optional for 'update'. (string, optional) - `description`: Label description text. Optional for 'create' and 'update'. (string, optional) - `method`: Operation to perform: 'create', 'update', or 'delete' (string, required) @@ -814,7 +814,7 @@ The following sets of tools are available: - `owner`: Repository owner (username or organization name) (string, required) - `repo`: Repository name (string, required) -- tag **list_label** - List labels from a repository +- **list_label** - List labels from a repository - `owner`: Repository owner (username or organization name) - required for all operations (string, required) - `repo`: Repository name - required for all operations (string, required) @@ -824,14 +824,14 @@ The following sets of tools are available: bell Notifications -- bell **dismiss_notification** - Dismiss notification +- **dismiss_notification** - Dismiss notification - `state`: The new state of the notification (read/done) (string, required) - `threadID`: The ID of the notification thread (string, required) -- bell **get_notification_details** - Get notification details +- **get_notification_details** - Get notification details - `notificationID`: The ID of the notification (string, required) -- bell **list_notifications** - List notifications +- **list_notifications** - List notifications - `before`: Only show notifications updated before the given time (ISO 8601 format) (string, optional) - `filter`: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional) @@ -840,16 +840,16 @@ The following sets of tools are available: - `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional) - `since`: Only show notifications updated after the given time (ISO 8601 format) (string, optional) -- bell **manage_notification_subscription** - Manage notification subscription +- **manage_notification_subscription** - Manage notification subscription - `action`: Action to perform: ignore, watch, or delete the notification subscription. (string, required) - `notificationID`: The ID of the notification thread. (string, required) -- bell **manage_repository_notification_subscription** - Manage repository notification subscription +- **manage_repository_notification_subscription** - Manage repository notification subscription - `action`: Action to perform: ignore, watch, or delete the repository notification subscription. (string, required) - `owner`: The account owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) -- bell **mark_all_notifications_read** - Mark all notifications as read +- **mark_all_notifications_read** - Mark all notifications as read - `lastReadAt`: Describes the last point that notifications were checked (optional). Default: Now (string, optional) - `owner`: Optional repository owner. If provided with repo, only notifications for this repository are marked as read. (string, optional) - `repo`: Optional repository name. If provided with owner, only notifications for this repository are marked as read. (string, optional) @@ -860,7 +860,7 @@ The following sets of tools are available: organization Organizations -- organization **search_orgs** - Search organizations +- **search_orgs** - Search organizations - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) @@ -873,38 +873,38 @@ The following sets of tools are available: project Projects -- project **add_project_item** - Add project item +- **add_project_item** - Add project item - `item_id`: The numeric ID of the issue or pull request to add to the project. (number, required) - `item_type`: The item's type, either issue or pull_request. (string, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) -- project **delete_project_item** - Delete project item +- **delete_project_item** - Delete project item - `item_id`: The internal project item ID to delete from the project (not the issue or pull request ID). (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) -- project **get_project** - Get project +- **get_project** - Get project - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number (number, required) -- project **get_project_field** - Get project field +- **get_project_field** - Get project field - `field_id`: The field's id. (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) -- project **get_project_item** - Get project item +- **get_project_item** - Get project item - `fields`: Specific list of field IDs to include in the response (e.g. ["102589", "985201", "169875"]). If not provided, only the title field is included. (string[], optional) - `item_id`: The item's ID. (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) - `project_number`: The project's number. (number, required) -- project **list_project_fields** - List project fields +- **list_project_fields** - List project fields - `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional) - `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) @@ -912,7 +912,7 @@ The following sets of tools are available: - `per_page`: Results per page (max 50) (number, optional) - `project_number`: The project's number. (number, required) -- project **list_project_items** - List project items +- **list_project_items** - List project items - `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional) - `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional) - `fields`: Field IDs to include (e.g. ["102589", "985201"]). CRITICAL: Always provide to get field values. Without this, only titles returned. (string[], optional) @@ -922,7 +922,7 @@ The following sets of tools are available: - `project_number`: The project's number. (number, required) - `query`: Query string for advanced filtering of project items using GitHub's project filtering syntax. (string, optional) -- project **list_projects** - List projects +- **list_projects** - List projects - `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional) - `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) @@ -930,7 +930,7 @@ The following sets of tools are available: - `per_page`: Results per page (max 50) (number, optional) - `query`: Filter projects by title text and open/closed state; permitted qualifiers: is:open, is:closed; examples: "roadmap is:open", "is:open feature planning". (string, optional) -- project **update_project_item** - Update project item +- **update_project_item** - Update project item - `item_id`: The unique identifier of the project item. This is not the issue or pull request ID. (number, required) - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required) - `owner_type`: Owner type (string, required) @@ -943,7 +943,7 @@ The following sets of tools are available: git-pull-request Pull Requests -- git-pull-request **add_comment_to_pending_review** - Add review comment to the requester's latest pending pull request review +- **add_comment_to_pending_review** - Add review comment to the requester's latest pending pull request review - `body`: The text of the review comment (string, required) - `line`: The line of the blob in the pull request diff that the comment applies to. For multi-line comments, the last line of the range (number, optional) - `owner`: Repository owner (string, required) @@ -955,7 +955,7 @@ The following sets of tools are available: - `startSide`: For multi-line comments, the starting side of the diff that the comment applies to. LEFT indicates the previous state, RIGHT indicates the new state (string, optional) - `subjectType`: The level at which the comment is targeted (string, required) -- git-pull-request **create_pull_request** - Open new pull request +- **create_pull_request** - Open new pull request - `base`: Branch to merge into (string, required) - `body`: PR description (string, optional) - `draft`: Create as draft PR (boolean, optional) @@ -965,7 +965,7 @@ The following sets of tools are available: - `repo`: Repository name (string, required) - `title`: PR title (string, required) -- git-pull-request **list_pull_requests** - List pull requests +- **list_pull_requests** - List pull requests - `base`: Filter by base branch (string, optional) - `direction`: Sort direction (string, optional) - `head`: Filter by head user/org and branch (string, optional) @@ -976,7 +976,7 @@ The following sets of tools are available: - `sort`: Sort by (string, optional) - `state`: Filter by state (string, optional) -- git-pull-request **merge_pull_request** - Merge pull request +- **merge_pull_request** - Merge pull request - `commit_message`: Extra detail for merge commit (string, optional) - `commit_title`: Title for merge commit (string, optional) - `merge_method`: Merge method (string, optional) @@ -984,7 +984,7 @@ The following sets of tools are available: - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) -- git-pull-request **pull_request_read** - Get details for a single pull request +- **pull_request_read** - Get details for a single pull request - `method`: Action to specify what pull request data needs to be retrieved from GitHub. Possible options: 1. get - Get details of a specific pull request. @@ -1001,7 +1001,7 @@ The following sets of tools are available: - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) -- git-pull-request **pull_request_review_write** - Write operations (create, submit, delete) on pull request reviews. +- **pull_request_review_write** - Write operations (create, submit, delete) on pull request reviews. - `body`: Review comment text (string, optional) - `commitID`: SHA of commit to review (string, optional) - `event`: Review action to perform. (string, optional) @@ -1010,12 +1010,12 @@ The following sets of tools are available: - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) -- git-pull-request **request_copilot_review** - Request Copilot review +- **request_copilot_review** - Request Copilot review - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) - `repo`: Repository name (string, required) -- git-pull-request **search_pull_requests** - Search pull requests +- **search_pull_requests** - Search pull requests - `order`: Sort order (string, optional) - `owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) @@ -1024,7 +1024,7 @@ The following sets of tools are available: - `repo`: Optional repository name. If provided with owner, only pull requests for this repository are listed. (string, optional) - `sort`: Sort field by number of matches of categories, defaults to best match (string, optional) -- git-pull-request **update_pull_request** - Edit pull request +- **update_pull_request** - Edit pull request - `base`: New base branch name (string, optional) - `body`: New description (string, optional) - `draft`: Mark pull request as draft (true) or ready for review (false) (boolean, optional) @@ -1036,7 +1036,7 @@ The following sets of tools are available: - `state`: New state (string, optional) - `title`: New title (string, optional) -- git-pull-request **update_pull_request_branch** - Update pull request branch +- **update_pull_request_branch** - Update pull request branch - `expectedHeadSha`: The expected SHA of the pull request's HEAD ref (string, optional) - `owner`: Repository owner (string, required) - `pullNumber`: Pull request number (number, required) @@ -1048,13 +1048,13 @@ The following sets of tools are available: repo Repositories -- repo **create_branch** - Create branch +- **create_branch** - Create branch - `branch`: Name for new branch (string, required) - `from_branch`: Source branch (defaults to repo default) (string, optional) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- repo **create_or_update_file** - Create or update file +- **create_or_update_file** - Create or update file - `branch`: Branch to create/update the file in (string, required) - `content`: Content of the file (string, required) - `message`: Commit message (string, required) @@ -1063,26 +1063,26 @@ The following sets of tools are available: - `repo`: Repository name (string, required) - `sha`: The blob SHA of the file being replaced. (string, optional) -- repo **create_repository** - Create repository +- **create_repository** - Create repository - `autoInit`: Initialize with README (boolean, optional) - `description`: Repository description (string, optional) - `name`: Repository name (string, required) - `organization`: Organization to create the repository in (omit to create in your personal account) (string, optional) - `private`: Whether repo should be private (boolean, optional) -- repo **delete_file** - Delete file +- **delete_file** - Delete file - `branch`: Branch to delete the file from (string, required) - `message`: Commit message (string, required) - `owner`: Repository owner (username or organization) (string, required) - `path`: Path to the file to delete (string, required) - `repo`: Repository name (string, required) -- repo **fork_repository** - Fork repository +- **fork_repository** - Fork repository - `organization`: Organization to fork to (string, optional) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- repo **get_commit** - Get commit details +- **get_commit** - Get commit details - `include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -1090,34 +1090,34 @@ The following sets of tools are available: - `repo`: Repository name (string, required) - `sha`: Commit SHA, branch name, or tag name (string, required) -- repo **get_file_contents** - Get file or directory contents +- **get_file_contents** - Get file or directory contents - `owner`: Repository owner (username or organization) (string, required) - `path`: Path to file/directory (string, optional) - `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional) - `repo`: Repository name (string, required) - `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional) -- repo **get_latest_release** - Get latest release +- **get_latest_release** - Get latest release - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- repo **get_release_by_tag** - Get a release by tag name +- **get_release_by_tag** - Get a release by tag name - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `tag`: Tag name (e.g., 'v1.0.0') (string, required) -- repo **get_tag** - Get tag details +- **get_tag** - Get tag details - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) - `tag`: Tag name (string, required) -- repo **list_branches** - List branches +- **list_branches** - List branches - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) -- repo **list_commits** - List commits +- **list_commits** - List commits - `author`: Author username or email address to filter commits by (string, optional) - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) @@ -1125,33 +1125,33 @@ The following sets of tools are available: - `repo`: Repository name (string, required) - `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional) -- repo **list_releases** - List releases +- **list_releases** - List releases - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) -- repo **list_tags** - List tags +- **list_tags** - List tags - `owner`: Repository owner (string, required) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `repo`: Repository name (string, required) -- repo **push_files** - Push files to repository +- **push_files** - Push files to repository - `branch`: Branch to push to (string, required) - `files`: Array of file objects to push, each object with path (string) and content (string) (object[], required) - `message`: Commit message (string, required) - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- repo **search_code** - Search code +- **search_code** - Search code - `order`: Sort order for results (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `query`: Search query using GitHub's powerful code search syntax. Examples: 'content:Skill language:Java org:github', 'NOT is:archived language:Python OR language:go', 'repo:github/github-mcp-server'. Supports exact matching, language filters, path filters, and more. (string, required) - `sort`: Sort field ('indexed' only) (string, optional) -- repo **search_repositories** - Search repositories +- **search_repositories** - Search repositories - `minimal_output`: Return minimal repository information (default: true). When false, returns full GitHub API repository objects. (boolean, optional) - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) @@ -1165,12 +1165,12 @@ The following sets of tools are available: shield-lock Secret Protection -- shield-lock **get_secret_scanning_alert** - Get secret scanning alert +- **get_secret_scanning_alert** - Get secret scanning alert - `alertNumber`: The number of the alert. (number, required) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) -- shield-lock **list_secret_scanning_alerts** - List secret scanning alerts +- **list_secret_scanning_alerts** - List secret scanning alerts - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) - `resolution`: Filter by resolution (string, optional) @@ -1183,10 +1183,10 @@ The following sets of tools are available: shield Security Advisories -- shield **get_global_security_advisory** - Get a global security advisory +- **get_global_security_advisory** - Get a global security advisory - `ghsaId`: GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, required) -- shield **list_global_security_advisories** - List global security advisories +- **list_global_security_advisories** - List global security advisories - `affects`: Filter advisories by affected package or version (e.g. "package1,package2@1.0.0"). (string, optional) - `cveId`: Filter by CVE ID. (string, optional) - `cwes`: Filter by Common Weakness Enumeration IDs (e.g. ["79", "284", "22"]). (string[], optional) @@ -1199,13 +1199,13 @@ The following sets of tools are available: - `type`: Advisory type. (string, optional) - `updated`: Filter by update date or date range (ISO 8601 date or range). (string, optional) -- shield **list_org_repository_security_advisories** - List org repository security advisories +- **list_org_repository_security_advisories** - List org repository security advisories - `direction`: Sort direction. (string, optional) - `org`: The organization login. (string, required) - `sort`: Sort field. (string, optional) - `state`: Filter by advisory state. (string, optional) -- shield **list_repository_security_advisories** - List repository security advisories +- **list_repository_security_advisories** - List repository security advisories - `direction`: Sort direction. (string, optional) - `owner`: The owner of the repository. (string, required) - `repo`: The name of the repository. (string, required) @@ -1218,18 +1218,18 @@ The following sets of tools are available: star Stargazers -- star **list_starred_repositories** - List starred repositories +- **list_starred_repositories** - List starred repositories - `direction`: The direction to sort the results by. (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) - `sort`: How to sort the results. Can be either 'created' (when the repository was starred) or 'updated' (when the repository was last pushed to). (string, optional) - `username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional) -- star **star_repository** - Star repository +- **star_repository** - Star repository - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) -- star **unstar_repository** - Unstar repository +- **unstar_repository** - Unstar repository - `owner`: Repository owner (string, required) - `repo`: Repository name (string, required) @@ -1239,7 +1239,7 @@ The following sets of tools are available: people Users -- people **search_users** - Search users +- **search_users** - Search users - `order`: Sort order (string, optional) - `page`: Page number for pagination (min 1) (number, optional) - `perPage`: Results per page for pagination (min 1, max 100) (number, optional) diff --git a/cmd/github-mcp-server/generate_docs.go b/cmd/github-mcp-server/generate_docs.go index 93988d1d..34d53d3f 100644 --- a/cmd/github-mcp-server/generate_docs.go +++ b/cmd/github-mcp-server/generate_docs.go @@ -213,12 +213,8 @@ func formatToolsetName(name string) string { } func writeToolDoc(buf *strings.Builder, tool mcp.Tool, icon string) { - // Tool name with icon (using annotation name instead of verbose description) - iconImg := octiconImg(icon) - if iconImg != "" { - iconImg += " " - } - fmt.Fprintf(buf, "- %s**%s** - %s\n", iconImg, tool.Name, tool.Annotations.Title) + // Tool name (no icon - section header already has the toolset icon) + fmt.Fprintf(buf, "- **%s** - %s\n", tool.Name, tool.Annotations.Title) // Parameters if tool.InputSchema == nil {