docs: remove duplicate get_job_logs entry in README#1732
docs: remove duplicate get_job_logs entry in README#1732harupy wants to merge 1 commit intogithub:mainfrom
Conversation
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR attempts to remove a duplicate get_job_logs tool entry from the README documentation by manually editing the auto-generated section. However, this approach is problematic because the README section between <!-- START AUTOMATED TOOLS --> and <!-- END AUTOMATED TOOLS --> markers is automatically generated by the script/generate-docs command.
Key Issue:
- The duplicate exists because two tool functions (
GetJobLogsandActionsGetJobLogs) both create tools named "get_job_logs" with opposing feature flags (FeatureFlagDisableandFeatureFlagEnableforFeatureFlagConsolidatedActions) - Both tools are registered in
pkg/github/tools.goand appear in documentation because the doc generator'sAllTools()method doesn't filter by feature flags - Manual edits to auto-generated sections will be overwritten when
script/generate-docsis next run - The docs-check CI workflow will fail when this happens
Proper Solution:
The fix should be in the documentation generation logic (cmd/github-mcp-server/generate_docs.go) or the inventory system to handle feature-flagged tool variants, not in the README itself.
Comments suppressed due to low confidence (1)
README.md:550
- This manual edit to the auto-generated section of README.md will be overwritten the next time
script/generate-docsis run. The duplicate entries exist because bothGetJobLogsandActionsGetJobLogsfunctions create tools with the same name "get_job_logs" and both are registered inpkg/github/tools.go(lines 244 and 257).
These are feature-flagged versions of the same tool that should not both appear in documentation. The fix should be in the doc generation logic to either:
- Filter out one of the versions (e.g., only show the non-consolidated version by default)
- Exclude tools with feature flags from AllTools() when generating docs
- Add special handling for tools with the same name
The proper fix would be in cmd/github-mcp-server/generate_docs.go or the inventory logic, not in the README itself.
- **get_job_logs** - Get GitHub Actions workflow job logs
- `failed_only`: When true, gets logs for all failed jobs in the workflow run specified by run_id. Requires run_id to be provided. (boolean, optional)
- `job_id`: The unique identifier of the workflow job. Required when getting logs for a single job. (number, optional)
- `owner`: Repository owner (string, required)
- `repo`: Repository name (string, required)
- `return_content`: Returns actual log content instead of URLs (boolean, optional)
- `run_id`: The unique identifier of the workflow run. Required when failed_only is true to get logs for all failed jobs in the run. (number, optional)
- `tail_lines`: Number of lines to return from the end of the log (number, optional)
|
Thanks, this is actually covered by #1721 It's generated documentation and there was an unhandled edge case. |
Summary
get_job_logstool entry from the READMETest plan
🤖 Generated with Claude Code