Skip to content

[q] Add source links to GitHub MCP tools report #17706

@github-actions

Description

@github-actions

Summary

Updates the github-mcp-tools-report workflow to include clickable links to source files in the generated discussion report, as requested in discussion #17701.

Changes Made

.github/workflows/github-mcp-tools-report.md

The report template now includes links to:

  1. Executive Summary — added Source and Instructions File fields with GitHub blob links:

    • pkg/workflow/data/github_toolsets_permissions.json
    • .github/instructions/github-mcp-server.instructions.md
  2. JSON Mapping Comparison section — the reference to pkg/workflow/data/github_toolsets_permissions.json is now a clickable link.

  3. Action field — when a PR is created for JSON mapping updates, the report now instructs the agent to include a link to the PR number and URL.

  4. Methodology section — added JSON Mapping and Instructions entries with clickable links to the referenced files.

  5. Report Quality guidelines — added "Link Sources" rule to ensure the agent always uses full GitHub URLs when referencing files and PRs.

Expected Improvement

Future report runs will produce discussions with clickable links to the source files, making it easier to navigate from the report to the actual data and documentation files.

Validation

Workflow compiled successfully: ✅ github-mcp-tools-report

Triggered by: discussion #17701 comment from @pelikhan

🎩 Equipped by Q

  • expires on Feb 24, 2026, 1:09 PM UTC

Note

This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download patch artifact

The patch file is available in the agent-artifacts artifact in the workflow run linked above.

To apply the patch locally:

# Download the artifact from the workflow run https://github.com/github/gh-aw/actions/runs/22277703782
# (Use GitHub MCP tools if gh CLI is not available)
gh run download 22277703782 -n agent-artifacts -D /tmp/agent-artifacts-22277703782

# The patch file will be at agent-artifacts/tmp/gh-aw/aw-q-mcp-tools-report-add-source-links.patch after download
# Apply the patch
git am /tmp/agent-artifacts-22277703782/aw-q-mcp-tools-report-add-source-links.patch
Show patch preview (72 of 72 lines)
From 89e64f30799dfba69444d657ff1859fbd66692b5 Mon Sep 17 00:00:00 2001
From: Copilot <copilot@github.com>
Date: Sun, 22 Feb 2026 13:08:12 +0000
Subject: [PATCH] feat: add source links to GitHub MCP tools report

Update the github-mcp-tools-report workflow to include clickable
links to source files in the generated discussion report:

- Link JSON mapping file in Executive Summary
- Link instructions file in Executive Summary
- Link JSON mapping file in JSON Mapping Comparison section
- Link PR when created for JSON mapping updates
- Link sources in Methodology section
- Add 'Link Sources' guideline to Report Quality section

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
 .github/workflows/github-mcp-tools-report.md | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/github-mcp-tools-report.md b/.github/workflows/github-mcp-tools-report.md
index efc40a5..6bf4d5e 100644
--- a/.github/workflows/github-mcp-tools-report.md
+++ b/.github/workflows/github-mcp-tools-report.md
@@ -163,6 +163,8 @@ Create a detailed markdown report with the following structure:
 - **Total Tools Discovered**: [NUMBER]
 - **Toolset Categories**: [NUMBER]
 - **Report Date**: [DATE]
+- **Source**: [`pkg/workflow/data/github_toolsets_permissions.json`](https://github.com/${{ github.repository }}/blob/main/pkg/workflow/data/github_toolsets_permissions.json)
+- **Instructions File**: [`.github/instructions/github-mcp-server.instructions.md`](https://github.com/${{ github.repository }}/blob/main/.github/instructions/github-mcp-server.instructions.md)
 - **Changes Since Last Report**: [If previous data exists, show changes summary]
   - **New Tools**: [NUMBER]
   - **Removed Tools**: [NUMBER]
@@ -186,7 +188,7 @@ Report any inconsistencies discovered during the systematic exploration:
 
 ### Discrepancies Between MCP Server and JSON Mapping
 
-Report on the comparison between the MCP server tools and the `pkg/workflow/data/github_tools
... (truncated)

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions