-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Exclude tools requiring feature flag from docs #1721
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
SamMorrowDrums
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The outcome is correct, but I think we could use existing filters to do the filtering, by providing an always false feature flag checker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR modifies the documentation generation logic to exclude tools that require feature flags (marked with FeatureFlagEnable) from the generated README.md documentation, as these tools are not available to regular users. The change ensures that consolidated actions tools, which are behind a feature flag, don't appear in the public documentation.
Key Changes
- Modified documentation generation to use
AvailableTools()with feature flag filtering instead ofAllTools() - Explicitly set all toolsets to be enabled during documentation generation
- Tools requiring feature flags (
FeatureFlagEnable) are now excluded from the README
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| cmd/github-mcp-server/generate_docs.go | Updated inventory building to explicitly enable all toolsets and changed from AllTools() to AvailableTools() to respect feature flag filtering |
| README.md | Removed documentation for 4 consolidated actions tools (actions_get, actions_list, actions_run_trigger, get_job_logs) that require the FeatureFlagConsolidatedActions feature flag |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Summary
This pull request updates the way documentation is generated for available GitHub toolsets. The change is that the generated documentation now only includes tools that are normally available to users, rather than polluting the documentation by listing all possible tools. This results in not including those that are disabled or behind feature flags.
Why
What changed
Documentation and Tool Availability Updates:
README.md:actions_get,actions_list,actions_run_trigger, andget_job_logs, as these are no longer available to regular users. [1] [2]generate_docs.goto include only tools available to regular users by specifying the toolset filterWithToolsets([]string{"all"}).MCP impact
Prompts tested (tool changes only)
Security / limits
Tool renaming
deprecated_tool_aliases.goNote: if you're renaming tools, you must add the tool aliases. For more information on how to do so, please refer to the official docs.
Lint & tests
./script/lint./script/testDocs