Address code review feedback and add tool interaction docs

Co-authored-by: SamMorrowDrums <[email protected]>

Author: Copilot

pkg/github/__toolsnaps__/issue_graph.snap

@@ -3,7 +3,7 @@
     "title": "Get issue relationship graph",
     "readOnlyHint": true
   },
-  "description": "Get a graph representation of an issue or pull request and its related issues/PRs.\n\nThis tool helps understand the relationships between issues and PRs in a repository, especially useful for:\n- Understanding the scope of work for an issue or PR\n- Planning implementation for a task that's part of a larger epic\n- Identifying blockers or dependencies\n- Finding related work that might conflict or overlap\n- Understanding why a piece of work exists (tracing to parent epic)\n\nThe graph shows:\n- Node types: epic (large initiatives), batch (parent issues), task (regular issues), pr (pull requests)\n- Parent/child relationships from sub-issues and \"closes/fixes\" references\n- Related issues mentioned in bodies\n\nCall this tool early when working on an issue to gather appropriate context about the work hierarchy.",
+  "description": "Get a graph representation of an issue or pull request and its related issues/PRs.\n\nThis tool helps understand the relationships between issues and PRs in a repository, especially useful for:\n- Understanding the scope of work for an issue or PR\n- Planning implementation for a task that's part of a larger epic\n- Identifying blockers or dependencies\n- Finding related work that might conflict or overlap\n- Understanding why a piece of work exists (tracing to parent epic)\n\nThe graph shows:\n- Node types: epic (large initiatives), batch (parent issues), task (regular issues), pr (pull requests)\n- Parent/child relationships from sub-issues and \"closes/fixes\" references\n- Related issues mentioned in bodies\n\nCall this tool early when working on an issue to gather appropriate context about the work hierarchy.\n\nWorks well with:\n- issue_read: After using issue_graph to identify important related issues, use issue_read to get full details of specific issues\n- pull_request_read: Use to get full PR details for PRs identified in the graph\n- search_issues: If the graph reveals related work areas, search for more issues in those areas\n- list_issues: List all issues in the repository to find additional context not captured in the graph",
   "inputSchema": {
     "properties": {
       "issue_number": {

pkg/github/issue_graph.go

@@ -18,7 +18,6 @@ import (
 
 const (
 	// MaxGraphDepth is the maximum depth to crawl for related issues
-	// Reduced to 3 for performance (can be increased in future versions)
 	MaxGraphDepth = 3
 	// MaxConcurrentFetches is the maximum number of concurrent API calls
 	MaxConcurrentFetches = 5
@@ -449,6 +448,7 @@ func (gc *graphCrawler) crawl(ctx context.Context) error {
 		current := queue[0]
 		queue = queue[1:]
 
+		// Skip if beyond max depth (shouldn't happen, but defensive check)
 		if current.depth > MaxGraphDepth {
 			continue
 		}
@@ -477,8 +477,8 @@ func (gc *graphCrawler) crawl(ctx context.Context) error {
 			continue
 		}
 
-		// Don't crawl further if at max depth
-		if current.depth >= MaxGraphDepth {
+		// Don't crawl further from nodes at max depth (they are leaf nodes for crawling)
+		if current.depth == MaxGraphDepth {
 			continue
 		}
 
@@ -541,9 +541,6 @@ func (gc *graphCrawler) crawl(ctx context.Context) error {
 						continue
 					}
 					subNumber := *subIssue.Number
-					if subNumber == 0 {
-						continue
-					}
 					subKey := nodeKey(current.owner, current.repo, subNumber)
 
 					// This node is parent of sub-issue
@@ -802,7 +799,13 @@ The graph shows:
 - Parent/child relationships from sub-issues and "closes/fixes" references
 - Related issues mentioned in bodies
 
-Call this tool early when working on an issue to gather appropriate context about the work hierarchy.`)),
+Call this tool early when working on an issue to gather appropriate context about the work hierarchy.
+
+Works well with:
+- issue_read: After using issue_graph to identify important related issues, use issue_read to get full details of specific issues
+- pull_request_read: Use to get full PR details for PRs identified in the graph
+- search_issues: If the graph reveals related work areas, search for more issues in those areas
+- list_issues: List all issues in the repository to find additional context not captured in the graph`)),
 			mcp.WithToolAnnotation(mcp.ToolAnnotation{
 				Title:        t("TOOL_ISSUE_GRAPH_USER_TITLE", "Get issue relationship graph"),
 				ReadOnlyHint: ToBoolPtr(true),

pkg/github/issue_graph_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"net/http"
+	"strings"
 	"testing"
 	"time"
 
@@ -415,9 +416,9 @@ func TestIssueGraphWithSubIssues(t *testing.T) {
 				path := r.URL.Path
 				var issue *github.Issue
 				switch {
-				case contains(path, "/101"):
+				case strings.Contains(path, "/101"):
 					issue = subIssue1
-				case contains(path, "/102"):
+				case strings.Contains(path, "/102"):
 					issue = subIssue2
 				default:
 					issue = parentIssue
@@ -432,7 +433,7 @@ func TestIssueGraphWithSubIssues(t *testing.T) {
 				requestCount++
 				// Return sub-issues only for the parent issue
 				path := r.URL.Path
-				if contains(path, "/100/") {
+				if strings.Contains(path, "/100/") {
 					w.WriteHeader(http.StatusOK)
 					_, _ = w.Write([]byte(subIssuesJSON))
 				} else {
@@ -470,17 +471,3 @@ func TestIssueGraphWithSubIssues(t *testing.T) {
 	assert.Contains(t, textContent.Text, "#100")
 	assert.Contains(t, textContent.Text, "Parent Issue")
 }
-
-// Helper function to check if path contains substring
-func contains(s, substr string) bool {
-	return len(s) >= len(substr) && (s == substr || len(s) > 0 && containsSubstr(s, substr))
-}
-
-func containsSubstr(s, substr string) bool {
-	for i := 0; i <= len(s)-len(substr); i++ {
-		if s[i:i+len(substr)] == substr {
-			return true
-		}
-	}
-	return false
-}