-
Notifications
You must be signed in to change notification settings - Fork 252
Closed
Description
Remove "Usage Examples" Section
This PR removes the "Usage Examples" section from the GitHub MCP server documentation as requested by @pelikhan in discussion #1971.
Changes Made
Files Modified
-
.github/instructions/github-mcp-server.instructions.md- Removed the "Usage Examples" section placeholder
- Updated file header to remove reference to "usage examples"
-
.github/workflows/github-mcp-tools-report.md- Removed "Usage Examples" section from report template
- Removed all references to usage examples in workflow instructions
- Updated report quality guidelines to remove "Practical Examples" bullet point
- Updated output requirements to remove usage examples generation
Impact
- The GitHub MCP server documentation will no longer include a "Usage Examples" section
- The automated workflow that generates this documentation (
github-mcp-tools-report.md) will no longer generate usage examples - This simplifies the documentation by focusing on tool reference and configuration
Rationale
Per the request in discussion #1971, the usage examples section is being removed from the GitHub MCP server documentation to streamline the content and reduce maintenance overhead.
Validation
- Changes are minimal and surgical, only affecting documentation files
- No code changes required
- No workflow compilation needed (these are documentation files only)
Closes #1971
AI generated by Q
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 as an artifact (aw.patch) in the workflow run linked above.
To apply the patch locally:
# Download the artifact from the workflow run https://github.com/githubnext/gh-aw/actions/runs/18637288234
# (Use GitHub MCP tools if gh CLI is not available)
gh run download 18637288234 -n aw.patch
# Apply the patch
git am aw.patchShow patch preview (94 of 94 lines)
From ccdd11b5457d5a064395d190a46e4c287244bb7e Mon Sep 17 00:00:00 2001
From: Q <github-actions[bot]@users.noreply.github.com>
Date: Sun, 19 Oct 2025 23:02:27 +0000
Subject: [PATCH] Remove 'Usage Examples' section from GitHub MCP server
documentation
- Removed 'Usage Examples' section from .github/instructions/github-mcp-server.instructions.md
- Updated github-mcp-tools-report.md workflow to not generate usage examples
- Removed all references to usage examples in workflow instructions and output requirements
- Updated file header to reflect the removal of usage examples from documentation scope
Addresses discussion #1971
---
.../instructions/github-mcp-server.instructions.md | 6 +-----
.github/workflows/github-mcp-tools-report.md | 11 ++---------
2 files changed, 3 insertions(+), 14 deletions(-)
diff --git a/.github/instructions/github-mcp-server.instructions.md b/.github/instructions/github-mcp-server.instructions.md
index 747ca7a..fa7e052 100644
--- a/.github/instructions/github-mcp-server.instructions.md
+++ b/.github/instructions/github-mcp-server.instructions.md
@@ -1,6 +1,6 @@
# GitHub MCP Server Documentation
-This file contains comprehensive documentation about the GitHub MCP (Model Context Protocol) server, including available tools, configuration options, and usage examples.
+This file contains comprehensive documentation about the GitHub MCP (Model Context Protocol) server, including available tools and configuration options.
**Note**: This file is automatically generated and updated by the `github-mcp-tools-report.md` workflow. Manual edits may be overwritten.
@@ -105,10 +105,6 @@ The local mode uses environment variables:
- `GITHUB_READ_ONLY=1` - Optional, enables read-only mode
- `GITHUB_TOOLSETS=<comma-separated-list>` - Optional, specifies enabled toolsets
-## Usage Examples
-
-[To be filled by workflow with practical examples]
-
## Best Practices
### Toolset Selection
diff --git a/.github/workflows/github-mcp-tool
... (truncated)Reactions are currently unavailable