Add tools for sub-issue endpoint by martinnormark · Pull Request #470 · github/github-mcp-server

martinnormark · 2025-06-03T22:19:48Z

Closes: #154

Note that I am calling the GitHub REST API, due to sub-issues not yet in go-github - however, it was merged in google/go-github#3580 so I'm happy to let this wait until they cut a new release and refactor.

Example use

I have tested the tools with a test repo here: https://github.com/martinnormark/gh-mcp-tests

Specifically I created 3 issues, where martinnormark/gh-mcp-tests#1 is the parent. You can look at the history there to see how sub-issues were added, removed, then added again.

It gracefully handled permission error due to token grants:

Fixed the token and asked to retry:

Asking to list sub-issues:

Removing a sub-issue from the parent, not mentioning the parent:

Adding it back again:

Asking to re-order:

The assertion was already checking User.Login but the mock was incomplete

martinnormark · 2025-06-26T10:21:28Z

Sub-issues in go-githubnow released. Will refactor the code here to use that, instead of direct REST calls.

* fix: Add SHA to get_file_contents while preserving MCP behavior (#595) Enhance get_file_contents to include SHA information without changing the existing MCP server response format. Changes: - Add Contents API call to retrieve SHA before fetching raw content - Include SHA in resourceURI (repo://owner/repo/sha/{SHA}/contents/path) - Add SHA to success messages - Update tests to verify SHA inclusion - Maintain original behavior: text files return raw text, binaries return base64 This preserves backward compatibility while providing SHA information for better file versioning support. Closes#595 * fix: Improve error handling for Contents API response Ensure response body is properly closed even when an error occurs by moving the defer statement before the error check. This prevents potential resource leaks when the Contents API returns an error with a non-nil response. Changes: - Move defer respContents.Body.Close() before error checking - Rename errContents to err for consistency - Add nil check for respContents before attempting to close body This follows Go best practices for handling HTTP responses and prevents potential goroutine/memory leaks. * revert changes to resource URI * use GraphQL API to get file SHA * refactor: mock GQL client instead of getFileSHA function to follow conventions * lint * revert GraphQL --------- Co-authored-by: LuluBeatson <lulubeatson@github.com>

@tonytrg

… governance info for the github server (#695) * Refactor README and add host installation guides, governance docs - Reorganized README for clarity and navigation - Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more - Clarified contribution guidelines and approval criteria - Added policies and governance documentation * Update README.md * Update README with configuration section for remote GitHub MCP Server * Update MCP access policy description in README Removing coding agent from the policy note, as the GitHub server is unaffected by this policy * Update configuration steps for GitHub Copilot in JetBrains IDEs... ...to reflect changes in accessing settings and configuring MCP. * Update install-other-copilot-ides.md * Update Eclipse MCP support version and configuration steps... ...for GitHub Copilot plugin in installation guide. * Update docs/installation-guides/install-cursor.md * Update docs/installation-guides/install-windsurf.md * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg --------- Co-authored-by: Tony Truong <tonytrg@github.com>

* shorten tool name * update function name to match tool name * adjust wording of descriptions

* Update installation guide for GitHub MCP Server Removed reference to GitHub.com in the installation guide. The GitHub server is available to Coding Agent by default, without installation needed. * Rename section to 'Install in Other MCP Hosts' Updating title for consistency and adding a link to the "other Copilot IDEs" install guide. * Revise installation guide for Cursor MCP setup Updated installation guide for Cursor with steps clarified, remote server installation, and one-click install deeplinks to open Cursor and add the github server to the config file.

- FYI:https://json-schema.org/understanding-json-schema/reference/numeric#integer

* Added installation instructions for mcpcurl * Update cmd/mcpcurl/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* initial pagination for `ListDiscussions` * redo category id var cast * add GraphQL pagination support for discussion comments and categories * remove pageinfo returns * fix out ref for linter * update docs * move to unified pagination for consensus on params * update docs * refactor pagination handling * update docs * linter fix * conv rest to gql params for safe lint * add nolint * add error handling for perPage value in ToGraphQLParams * refactor pagination error handling * unified params for rest andn graphql and rennamed to be uniform for golang * add 'after' for pagination * update docs * Update pkg/github/discussions.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update pkg/github/discussions.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update pkg/github/discussions_test.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * update default page size const * reduce default pagination size from 100 to 30 in discussion tests * update pagination for reverse and total * update pagination to remove from discussions * updated README * improve the `ToGraphQLParams` function --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull Request Overview

This PR adds four new tools for managing GitHub sub-issues functionality, enabling users to add, list, remove, and reprioritize sub-issues through the GitHub MCP server. The changes include comprehensive test coverage and direct REST API integration since sub-issues are not yet available in the go-github library.

Adds sub-issue management tools to the default toolset configuration
Implements four new sub-issue operations with proper error handling and validation
Provides extensive test coverage for all sub-issue operations including edge cases

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
pkg/github/tools.go	Registers new sub-issue tools in the default toolset
pkg/github/issues.go	Implements four sub-issue management functions with REST API integration
pkg/github/issues_test.go	Comprehensive test suite covering all sub-issue operations and edge cases
pkg/github/toolsnaps/*.snap	Tool schema snapshots for sub-issue operations
README.md	Documentation updates describing the new sub-issue tools and their parameters

Comments suppressed due to low confidence (2)

pkg/github/issues.go:177

[nitpick] The parameter name 'sub_issue_id' is inconsistent with GitHub API conventions. Consider renaming to 'sub_issue_number' for consistency with other issue number parameters in the codebase.

 mcp.WithNumber("sub_issue_id",

pkg/github/issues_test.go:1804

[nitpick] Test case 'missing required parameter owner' creates a mockedClient but doesn't need it since validation fails before any HTTP call. This creates unnecessary test setup overhead.

 mockedClient: mock.NewMockedHTTPClient(

LuluBeatson · 2025-07-21T18:38:18Z

Thank you @martinnormark for adding the sub-issue tools and for updating go-github to v73 (#597)!

We have:

Updated this branch, bringing the go-github upgrade
Refactored the Add, List, Reprioritize tools to use the go-github client methods for sub-issues
- For Delete, we've left it as your original HTTP DELETE request because of a bug in the go-github client's method for this endpoint. Once the fix is released, this tool can be refactored as a follow up.
Refactored the unit tests to use go-github-mock's existing endpoint patterns
Added toolsnaps and auto-generated docs for the new tools

Add

List

Reprioritise

Delete

martinnormark · 2025-07-21T23:09:59Z

@LuluBeatson Fantastic! Thanks for progressing it!

@tonytrg

* Create 'add sub-issue' tool * Fix hardcoded API host * Create 'list sub-issues' tool * Create 'remove sub-issue' tool * Fix Test_GetIssue mock data - add missing User field The assertion was already checking User.Login but the mock was incomplete * Create 'reprioritize sub-issue' tool * fixes * use go github pck to add sub-issues * Update to use go github package * update description * update to use go github v73 * lint, docs * refactor: tests to use go-github-mock * add toolsnaps * make RemoveSubIssue use NewGitHubAPIErrorResponse, update docstring * Always include SHA in get_file_contents responses (github#676) * fix: Add SHA to get_file_contents while preserving MCP behavior (github#595) Enhance get_file_contents to include SHA information without changing the existing MCP server response format. Changes: - Add Contents API call to retrieve SHA before fetching raw content - Include SHA in resourceURI (repo://owner/repo/sha/{SHA}/contents/path) - Add SHA to success messages - Update tests to verify SHA inclusion - Maintain original behavior: text files return raw text, binaries return base64 This preserves backward compatibility while providing SHA information for better file versioning support. Closesgithub#595 * fix: Improve error handling for Contents API response Ensure response body is properly closed even when an error occurs by moving the defer statement before the error check. This prevents potential resource leaks when the Contents API returns an error with a non-nil response. Changes: - Move defer respContents.Body.Close() before error checking - Rename errContents to err for consistency - Add nil check for respContents before attempting to close body This follows Go best practices for handling HTTP responses and prevents potential goroutine/memory leaks. * revert changes to resource URI * use GraphQL API to get file SHA * refactor: mock GQL client instead of getFileSHA function to follow conventions * lint * revert GraphQL --------- Co-authored-by: LuluBeatson <lulubeatson@github.com> * Reorganize README, add dedicated install guides, include policies and governance info for the github server (github#695) * Refactor README and add host installation guides, governance docs - Reorganized README for clarity and navigation - Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more - Clarified contribution guidelines and approval criteria - Added policies and governance documentation * Update README.md * Update README with configuration section for remote GitHub MCP Server * Update MCP access policy description in README Removing coding agent from the policy note, as the GitHub server is unaffected by this policy * Update configuration steps for GitHub Copilot in JetBrains IDEs... ...to reflect changes in accessing settings and configuring MCP. * Update install-other-copilot-ides.md * Update Eclipse MCP support version and configuration steps... ...for GitHub Copilot plugin in installation guide. * Update docs/installation-guides/install-cursor.md * Update docs/installation-guides/install-windsurf.md * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg --------- Co-authored-by: Tony Truong <tonytrg@github.com> * fix: shorten long tool name for adding pr review comments (github#697) * shorten tool name * update function name to match tool name * adjust wording of descriptions * Update installation guide for GitHub MCP Server (github#699) * Update installation guide for GitHub MCP Server Removed reference to GitHub.com in the installation guide. The GitHub server is available to Coding Agent by default, without installation needed. * Rename section to 'Install in Other MCP Hosts' Updating title for consistency and adding a link to the "other Copilot IDEs" install guide. * Revise installation guide for Cursor MCP setup Updated installation guide for Cursor with steps clarified, remote server installation, and one-click install deeplinks to open Cursor and add the github server to the config file. * fix: make mcpcurl support "integer" type (github#688) - FYI:https://json-schema.org/understanding-json-schema/reference/numeric#integer * Added installation instructions for mcpcurl (github#719) * Added installation instructions for mcpcurl * Update cmd/mcpcurl/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add pagination support to GraphQL-based tools (github#683) * initial pagination for `ListDiscussions` * redo category id var cast * add GraphQL pagination support for discussion comments and categories * remove pageinfo returns * fix out ref for linter * update docs * move to unified pagination for consensus on params * update docs * refactor pagination handling * update docs * linter fix * conv rest to gql params for safe lint * add nolint * add error handling for perPage value in ToGraphQLParams * refactor pagination error handling * unified params for rest andn graphql and rennamed to be uniform for golang * add 'after' for pagination * update docs * Update pkg/github/discussions.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update pkg/github/discussions.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update pkg/github/discussions_test.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * update default page size const * reduce default pagination size from 100 to 30 in discussion tests * update pagination for reverse and total * update pagination to remove from discussions * updated README * improve the `ToGraphQLParams` function --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * shorten param descriptions * fix: resp nil check in error handling in RemoveSubIssue function --------- Co-authored-by: LuluBeatson <lulubeatson@github.com> Co-authored-by: tommaso-moro <tommaso-moro@github.com>

CopilotAI review requested due to automatic review settings June 3, 2025 22:19

martinnormark requested a review from a team as a code owner June 3, 2025 22:19

This comment was marked as outdated.
Sign in to view

a-man-called-q mentioned this pull request Jun 14, 2025
Sub-issue endpoint #154
Closed

martinnormark added 7 commits June 19, 2025 19:35

Create 'add sub-issue' tool
0d6d026

Fix hardcoded API host
080e498

Create 'list sub-issues' tool
9b8ebc0

Create 'remove sub-issue' tool
9c527bf

Fix Test_GetIssue mock data - add missing User field
a0e757a
The assertion was already checking User.Login but the mock was incomplete

Create 'reprioritize sub-issue' tool
39f8045

Merge branch 'main' into feat/sub-issues
c900cca

martinnormark marked this pull request as draft June 26, 2025 10:21

Merge branch 'main' into feat/sub-issues
15f8c9f

martinnormark mentioned this pull request Jun 27, 2025
Bump go-github to v73.0.0 #597
Merged

LuluBeatsonand others added 3 commits July 17, 2025 09:43

Merge remote-tracking branch 'origin/main' into feat/sub-issues
2c10588

fixes
ef56393

use go github pck to add sub-issues
e7ac4b0

LuluBeatson assigned tommaso-moro Jul 17, 2025

tommaso-moro added 3 commits July 18, 2025 16:49

Update to use go github package
71712b8

update description
26469ad

update to use go github v73
34465bd

LuluBeatson self-assigned this Jul 21, 2025

LuluBeatsonand others added 6 commits July 21, 2025 19:20

lint, docs
655d301

refactor: tests to use go-github-mock
0907c82

add toolsnaps
d166d88

make RemoveSubIssue use NewGitHubAPIErrorResponse, update docstring
49be86f

LuluBeatsonand others added 7 commits July 21, 2025 19:20

fix: shorten long tool name for adding pr review comments (#697)
51b61a2
* shorten tool name * update function name to match tool name * adjust wording of descriptions

fix: make mcpcurl support "integer" type (#688)
2916388
- FYI:https://json-schema.org/understanding-json-schema/reference/numeric#integer

Added installation instructions for mcpcurl (#719)
3f85c7d
* Added installation instructions for mcpcurl * Update cmd/mcpcurl/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

shorten param descriptions
c2328d0

Merge branch 'main' into feat/sub-issues
96e2c8f

LuluBeatson marked this pull request as ready for review July 21, 2025 18:28

LuluBeatson requested a review from Copilot July 21, 2025 18:29

CopilotAI reviewed Jul 21, 2025
View reviewed changes

Comment threadpkg/github/issues.go
Comment threadpkg/github/issues.go
Comment threadpkg/github/issues.go Outdated

fix: resp nil check in error handling in RemoveSubIssue function
e742c19

JoannaaKL approved these changes Jul 22, 2025
View reviewed changes

LuluBeatson merged commit 60a5391 into github:mainJul 22, 2025
10 checks passed

martinnormark deleted the feat/sub-issues branch July 22, 2025 09:08

BrewTestBot mentioned this pull request Jul 25, 2025
github-mcp-server 0.9.0 Homebrew/homebrew-core#231202
Merged

Navigation Menu

Uh oh!

Add tools for sub-issue endpoint - #470

Add tools for sub-issue endpoint#470
LuluBeatson merged 28 commits into
github:mainfrom
martinnormark:feat/sub-issues

martinnormark commented Jun 3, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

martinnormark commented Jun 26, 2025

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LuluBeatson commented Jul 21, 2025

Uh oh!

martinnormark commented Jul 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Uh oh!

Conversation

martinnormark commented Jun 3, 2025

Example use

Uh oh!

This comment was marked as outdated.

Uh oh!

martinnormark commented Jun 26, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LuluBeatson commented Jul 21, 2025

Uh oh!

martinnormark commented Jul 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants