Merge branch 'main' into actions-consolidation-backport

Author: mattdholloway

README.md

@@ -1047,7 +1047,7 @@ The following sets of tools are available:
 
 - **get_file_contents** - Get file or directory contents
   - `owner`: Repository owner (username or organization) (string, required)
-  - `path`: Path to file/directory (directories must end with a slash '/') (string, optional)
+  - `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)

pkg/github/__toolsnaps__/get_file_contents.snap

@@ -17,7 +17,7 @@
       },
       "path": {
         "type": "string",
-        "description": "Path to file/directory (directories must end with a slash '/')",
+        "description": "Path to file/directory",
         "default": "/"
       },
       "ref": {

pkg/github/repositories.go

@@ -560,7 +560,7 @@ func GetFileContents(getClient GetClientFn, getRawClient raw.GetRawClientFn, t t
 				},
 				"path": {
 					Type:        "string",
-					Description: "Path to file/directory (directories must end with a slash '/')",
+					Description: "Path to file/directory",
 					Default:     json.RawMessage(`"/"`),
 				},
 				"ref": {
@@ -608,28 +608,26 @@ func GetFileContents(getClient GetClientFn, getRawClient raw.GetRawClientFn, t t
 			return utils.NewToolResultError(fmt.Sprintf("failed to resolve git reference: %s", err)), nil, nil
 		}
 
-		// If the path is (most likely) not to be a directory, we will
-		// first try to get the raw content from the GitHub raw content API.
+		if rawOpts.SHA != "" {
+			ref = rawOpts.SHA
+		}
 
-		var rawAPIResponseCode int
-		if path != "" && !strings.HasSuffix(path, "/") {
-			// First, get file info from Contents API to retrieve SHA
-			var fileSHA string
-			opts := &github.RepositoryContentGetOptions{Ref: ref}
-			fileContent, _, respContents, err := client.Repositories.GetContents(ctx, owner, repo, path, opts)
-			if respContents != nil {
-				defer func() { _ = respContents.Body.Close() }()
-			}
-			if err != nil {
-				return ghErrors.NewGitHubAPIErrorResponse(ctx,
-					"failed to get file SHA",
-					respContents,
-					err,
-				), nil, nil
-			}
-			if fileContent == nil || fileContent.SHA == nil {
-				return utils.NewToolResultError("file content SHA is nil, if a directory was requested, path parameters should end with a trailing slash '/'"), nil, nil
-			}
+		var fileSHA string
+		opts := &github.RepositoryContentGetOptions{Ref: ref}
+
+		// Always call GitHub Contents API first to get metadata including SHA and determine if it's a file or directory
+		fileContent, dirContent, respContents, err := client.Repositories.GetContents(ctx, owner, repo, path, opts)
+		if respContents != nil {
+			defer func() { _ = respContents.Body.Close() }()
+		}
+
+		// The path does not point to a file or directory.
+		// Instead let's try to find it in the Git Tree by matching the end of the path.
+		if err != nil || (fileContent == nil && dirContent == nil) {
+			return matchFiles(ctx, client, owner, repo, ref, path, rawOpts, 0)
+		}
+
+		if fileContent != nil && fileContent.SHA != nil {
 			fileSHA = *fileContent.SHA
 
 			rawClient, err := getRawClient(ctx)
@@ -702,55 +700,19 @@ func GetFileContents(getClient GetClientFn, getRawClient raw.GetRawClientFn, t t
 				}
 				return utils.NewToolResultResource("successfully downloaded binary file", result), nil, nil
 			}
-			rawAPIResponseCode = resp.StatusCode
-		}
 
-		if rawOpts.SHA != "" {
-			ref = rawOpts.SHA
-		}
-		if strings.HasSuffix(path, "/") {
-			opts := &github.RepositoryContentGetOptions{Ref: ref}
-			_, dirContent, resp, err := client.Repositories.GetContents(ctx, owner, repo, path, opts)
-			if err == nil && resp.StatusCode == http.StatusOK {
-				defer func() { _ = resp.Body.Close() }()
-				r, err := json.Marshal(dirContent)
-				if err != nil {
-					return utils.NewToolResultError("failed to marshal response"), nil, nil
-				}
-				return utils.NewToolResultText(string(r)), nil, nil
-			}
-		}
-
-		// The path does not point to a file or directory.
-		// Instead let's try to find it in the Git Tree by matching the end of the path.
-
-		// Step 1: Get Git Tree recursively
-		tree, resp, err := client.Git.GetTree(ctx, owner, repo, ref, true)
-		if err != nil {
-			return ghErrors.NewGitHubAPIErrorResponse(ctx,
-				"failed to get git tree",
-				resp,
-				err,
-			), nil, nil
-		}
-		defer func() { _ = resp.Body.Close() }()
-
-		// Step 2: Filter tree for matching paths
-		const maxMatchingFiles = 3
-		matchingFiles := filterPaths(tree.Entries, path, maxMatchingFiles)
-		if len(matchingFiles) > 0 {
-			matchingFilesJSON, err := json.Marshal(matchingFiles)
+			// Raw API call failed
+			return matchFiles(ctx, client, owner, repo, ref, path, rawOpts, resp.StatusCode)
+		} else if dirContent != nil {
+			// file content or file SHA is nil which means it's a directory
+			r, err := json.Marshal(dirContent)
 			if err != nil {
-				return utils.NewToolResultError(fmt.Sprintf("failed to marshal matching files: %s", err)), nil, nil
+				return utils.NewToolResultError("failed to marshal response"), nil, nil
 			}
-			resolvedRefs, err := json.Marshal(rawOpts)
-			if err != nil {
-				return utils.NewToolResultError(fmt.Sprintf("failed to marshal resolved refs: %s", err)), nil, nil
-			}
-			return utils.NewToolResultError(fmt.Sprintf("Resolved potential matches in the repository tree (resolved refs: %s, matching files: %s), but the raw content API returned an unexpected status code %d.", string(resolvedRefs), string(matchingFilesJSON), rawAPIResponseCode)), nil, nil
+			return utils.NewToolResultText(string(r)), nil, nil
 		}
 
-		return utils.NewToolResultError("Failed to get file contents. The path does not point to a file or directory, or the file does not exist in the repository."), nil, nil
+		return utils.NewToolResultError("failed to get file contents"), nil, nil
 	})
 
 	return tool, handler
@@ -2115,3 +2077,35 @@ func UnstarRepository(getClient GetClientFn, t translations.TranslationHelperFun
 
 	return tool, handler
 }
+
+func matchFiles(ctx context.Context, client *github.Client, owner, repo, ref, path string, rawOpts *raw.ContentOpts, rawAPIResponseCode int) (*mcp.CallToolResult, any, error) {
+	// Step 1: Get Git Tree recursively
+	tree, response, err := client.Git.GetTree(ctx, owner, repo, ref, true)
+	if err != nil {
+		return ghErrors.NewGitHubAPIErrorResponse(ctx,
+			"failed to get git tree",
+			response,
+			err,
+		), nil, nil
+	}
+	defer func() { _ = response.Body.Close() }()
+
+	// Step 2: Filter tree for matching paths
+	const maxMatchingFiles = 3
+	matchingFiles := filterPaths(tree.Entries, path, maxMatchingFiles)
+	if len(matchingFiles) > 0 {
+		matchingFilesJSON, err := json.Marshal(matchingFiles)
+		if err != nil {
+			return utils.NewToolResultError(fmt.Sprintf("failed to marshal matching files: %s", err)), nil, nil
+		}
+		resolvedRefs, err := json.Marshal(rawOpts)
+		if err != nil {
+			return utils.NewToolResultError(fmt.Sprintf("failed to marshal resolved refs: %s", err)), nil, nil
+		}
+		if rawAPIResponseCode > 0 {
+			return utils.NewToolResultText(fmt.Sprintf("Resolved potential matches in the repository tree (resolved refs: %s, matching files: %s), but the content API returned an unexpected status code %d.", string(resolvedRefs), string(matchingFilesJSON), rawAPIResponseCode)), nil, nil
+		}
+		return utils.NewToolResultText(fmt.Sprintf("Resolved potential matches in the repository tree (resolved refs: %s, matching files: %s).", string(resolvedRefs), string(matchingFilesJSON))), nil, nil
+	}
+	return utils.NewToolResultError("Failed to get file contents. The path does not point to a file or directory, or the file does not exist in the repository."), nil, nil
+}

script/licenses

@@ -1,21 +1,163 @@
 #!/bin/bash
+#
+# Generate license files for all platform/arch combinations.
+# This script handles architecture-specific dependency differences by:
+# 1. Generating separate license reports per GOOS/GOARCH combination
+# 2. Grouping identical reports together (comma-separated arch names)
+# 3. Creating an index at the top of each platform file
+# 4. Copying all license files to third-party/
+#
+# Note: third-party/ is a union of all license files across all architectures.
+# This means that license files for dependencies present in only some architectures
+# may still appear in third-party/. This is intentional and ensures compliance.
+#
+# Note: we ignore warnings because we want the command to succeed, however the output should be checked
+#       for any new warnings, and potentially we may need to add license information.
+#
+#       Normally these warnings are packages containing non go code, which may or may not require explicit attribution,
+#       depending on the license.
+
+set -e
 
 go install github.com/google/go-licenses@latest
 
+# actions/setup-go does not setup the installed toolchain to be preferred over the system install,
+# which causes go-licenses to raise "Package ... does not have module info" errors in CI.
+# For more information, https://github.com/google/go-licenses/issues/244#issuecomment-1885098633
+if [ "$CI" = "true" ]; then
+    export GOROOT=$(go env GOROOT)
+    export PATH=${GOROOT}/bin:$PATH
+fi
+
 rm -rf third-party
 mkdir -p third-party
 export TEMPDIR="$(mktemp -d)"
 
 trap "rm -fr ${TEMPDIR}" EXIT
 
-for goos in linux darwin windows ; do
-    # Note: we ignore warnings because we want the command to succeed, however the output should be checked
-    #       for any new warnings, and potentially we may need to add license information. 
-    #
-    #       Normally these warnings are packages containing non go code, which may or may not require explicit attribution,
-    #       depending on the license.
-    GOOS="${goos}" GOFLAGS=-mod=mod go-licenses save ./... --save_path="${TEMPDIR}/${goos}" --force || echo "Ignore warnings"
-    GOOS="${goos}" GOFLAGS=-mod=mod go-licenses report ./... --template .github/licenses.tmpl > third-party-licenses.${goos}.md || echo "Ignore warnings"
-    cp -fR "${TEMPDIR}/${goos}"/* third-party/
+# Cross-platform hash function (works on both Linux and macOS)
+compute_hash() {
+    if command -v md5sum >/dev/null 2>&1; then
+        md5sum | cut -d' ' -f1
+    elif command -v md5 >/dev/null 2>&1; then
+        md5 -q
+    else
+        # Fallback to cksum if neither is available
+        cksum | cut -d' ' -f1
+    fi
+}
+
+# Function to get architectures for a given OS
+get_archs() {
+    case "$1" in
+        linux)   echo "386 amd64 arm64" ;;
+        darwin)  echo "amd64 arm64" ;;
+        windows) echo "386 amd64 arm64" ;;
+    esac
+}
+
+# Generate reports for each platform/arch combination
+for goos in darwin linux windows; do
+    echo "Processing ${goos}..."
+    
+    archs=$(get_archs "$goos")
+    
+    for goarch in $archs; do
+        echo "  Generating for ${goos}/${goarch}..."
+        
+        # Generate the license report for this arch
+        report_file="${TEMPDIR}/${goos}_${goarch}_report.md"
+        GOOS="${goos}" GOARCH="${goarch}" GOFLAGS=-mod=mod go-licenses report ./... --template .github/licenses.tmpl > "${report_file}" 2>/dev/null || echo "  (warnings ignored for ${goos}/${goarch})"
+        
+        # Save licenses to temp directory
+        GOOS="${goos}" GOARCH="${goarch}" GOFLAGS=-mod=mod go-licenses save ./... --save_path="${TEMPDIR}/${goos}_${goarch}" --force 2>/dev/null || echo "  (warnings ignored for ${goos}/${goarch})"
+        
+        # Copy to third-party (accumulate all - union of all architectures for compliance)
+        if [ -d "${TEMPDIR}/${goos}_${goarch}" ]; then
+            cp -fR "${TEMPDIR}/${goos}_${goarch}"/* third-party/ 2>/dev/null || true
+        fi
+        
+        # Extract just the package list (skip header), sort it, and hash it
+        # Use LC_ALL=C for consistent sorting across different systems
+        packages_file="${TEMPDIR}/${goos}_${goarch}_packages.txt"
+        if [ -s "${report_file}" ] && grep -qE '^ - \[' "${report_file}" 2>/dev/null; then
+            grep -E '^ - \[' "${report_file}" | LC_ALL=C sort > "${packages_file}"
+            hash=$(cat "${packages_file}" | compute_hash)
+        else
+            echo "(FAILED TO GENERATE LICENSE REPORT FOR ${goos}/${goarch})" > "${packages_file}"
+            hash="FAILED_${goos}_${goarch}"
+        fi
+        
+        # Store hash for grouping
+        echo "${hash}" > "${TEMPDIR}/${goos}_${goarch}_hash.txt"
+    done
+    
+    # Group architectures with identical reports (deterministic order)
+    # Create groups file: hash -> comma-separated archs
+    groups_file="${TEMPDIR}/${goos}_groups.txt"
+    rm -f "${groups_file}"
+    
+    # Process architectures in order to build groups
+    for goarch in $archs; do
+        hash=$(cat "${TEMPDIR}/${goos}_${goarch}_hash.txt")
+        # Check if we've seen this hash before
+        if grep -q "^${hash}:" "${groups_file}" 2>/dev/null; then
+            # Append to existing group
+            existing=$(grep "^${hash}:" "${groups_file}" | cut -d: -f2)
+            sed -i.bak "s/^${hash}:.*/${hash}:${existing}, ${goarch}/" "${groups_file}"
+            rm -f "${groups_file}.bak"
+        else
+            # New group
+            echo "${hash}:${goarch}" >> "${groups_file}"
+        fi
+    done
+    
+    # Generate the combined report for this platform
+    output_file="third-party-licenses.${goos}.md"
+    
+    cat > "${output_file}" << 'EOF'
+# GitHub MCP Server dependencies
+
+The following open source dependencies are used to build the [github/github-mcp-server][] GitHub Model Context Protocol Server.
+
+## Table of Contents
+
+EOF
+
+    # Build table of contents (sorted for determinism)
+    # Use LC_ALL=C for consistent sorting across different systems
+    LC_ALL=C sort "${groups_file}" | while IFS=: read -r hash group_archs; do
+        # Create anchor-friendly name
+        anchor=$(echo "${group_archs}" | tr ', ' '-' | tr -s '-')
+        echo "- [${group_archs}](#${anchor})" >> "${output_file}"
+    done
+    
+    echo "" >> "${output_file}"
+    echo "---" >> "${output_file}"
+    echo "" >> "${output_file}"
+    
+    # Add each unique report section (sorted for determinism)
+    # Use LC_ALL=C for consistent sorting across different systems
+    LC_ALL=C sort "${groups_file}" | while IFS=: read -r hash group_archs; do
+        # Get the packages from the first arch in this group
+        first_arch=$(echo "${group_archs}" | cut -d',' -f1 | tr -d ' ')
+        packages=$(cat "${TEMPDIR}/${goos}_${first_arch}_packages.txt")
+        
+        cat >> "${output_file}" << EOF
+## ${group_archs}
+
+The following packages are included for the ${group_archs} architectures.
+
+${packages}
+
+EOF
+    done
+    
+    # Add footer
+    echo "[github/github-mcp-server]: https://github.com/github/github-mcp-server" >> "${output_file}"
+    
+    echo "Generated ${output_file}"
 done
 
+echo "Done! License files generated."
+

script/licenses-check

@@ -1,21 +1,34 @@
 #!/bin/bash
+#
+# Check that license files are up to date.
+# This script regenerates the license files and compares them with the committed versions.
+# If there are differences, it exits with an error.
 
-go install github.com/google/go-licenses@latest
-
-for goos in linux darwin windows ; do
-    # Note: we ignore warnings because we want the command to succeed, however the output should be checked
-    #       for any new warnings, and potentially we may need to add license information. 
-    #
-    #       Normally these warnings are packages containing non go code, which may or may not require explicit attribution,
-    #       depending on the license.
-    GOOS="${goos}" GOFLAGS=-mod=mod go-licenses report ./... --template .github/licenses.tmpl > third-party-licenses.${goos}.copy.md || echo "Ignore warnings"
-    if ! diff -s third-party-licenses.${goos}.copy.md third-party-licenses.${goos}.md; then
-        printf "License check failed.\n\nPlease update the license file by running \`.script/licenses\` and committing the output."
-        rm -f third-party-licenses.${goos}.copy.md
-        exit 1
-    fi
-    rm -f third-party-licenses.${goos}.copy.md
+set -e
+
+# Store original files for comparison
+TEMPDIR="$(mktemp -d)"
+trap "rm -fr ${TEMPDIR}" EXIT
+
+# Save original license markdown files
+for goos in darwin linux windows; do
+    cp "third-party-licenses.${goos}.md" "${TEMPDIR}/"
 done
 
+# Save the state of third-party directory
+cp -r third-party "${TEMPDIR}/third-party.orig"
+
+# Regenerate using the same script
+./script/licenses
+
+# Check for any differences in workspace
+if ! git diff --exit-code --quiet third-party-licenses.*.md third-party/; then
+    echo "License files are out of date:"
+    git diff third-party-licenses.*.md third-party/
+    echo ""
+    printf "\nLicense check failed.\n\nPlease update the license files by running \`./script/licenses\` and committing the output.\n"
+    exit 1
+fi
 
+echo "License check passed for all platforms."