docs: document sync-tool-docs.yml workflow in AGENTS.md - #898
Conversation
Add the workflow to the CI/CD table and update the Tool Tags section to clarify that tools.json, README, and DOCS.md are auto-regenerated on merge — no manual regeneration needed.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the project documentation by clarifying the automated nature of tool documentation and data synchronization. It ensures contributors are aware that manual script execution is no longer required for these tasks, as they are handled by the CI/CD pipeline. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the AGENTS.md documentation to include the sync-tool-docs.yml workflow, which automates the regeneration of tools.json, README, and DOCS.md upon pushes to the master branch. The review feedback identifies two areas for improvement: correcting the documented trigger path for the workflow to src/ha_mcp/tools/ and ensuring that homeassistant-addon/DOCS.md is consistently listed as an auto-generated file in the Tool Tags section.
- Fix trigger path: tools/ → src/ha_mcp/tools/ - Add homeassistant-addon/DOCS.md to Tool Tags section
kingpanther13
left a comment
kingpanther13
left a comment
There was a problem hiding this comment.
Review
Good idea documenting this workflow — it was created in #849 (based on the extract_tools.py script from #839) and clearly not visible enough given the confusion on #871. Two accuracy issues to fix:
1. Trigger path is inaccurate
The table entry says Push to master (tools/) but the actual workflow triggers on src/ha_mcp/tools/** and scripts/extract_tools.py. The shorthand tools/ is misleading since there's no top-level tools/ directory. Should match the real paths:
| `sync-tool-docs.yml` | Push to master (`src/ha_mcp/tools/`, `scripts/extract_tools.py`) | Regenerate `tools.json`, README, DOCS.md |2. Tool Tags section omits homeassistant-addon/DOCS.md
The workflow regenerates three files: site/src/data/tools.json, README.md, and homeassistant-addon/DOCS.md (visible in the workflow's git add step). The updated Tool Tags text mentions only the README table and tools.json. Should list all three so agents know the full scope of auto-generated files — this was the exact confusion that triggered this PR on #871.
|
Both issues from your review are addressed in the latest commits:
|
kingpanther13
left a comment
kingpanther13
left a comment
There was a problem hiding this comment.
Both issues from the previous review are addressed. Trigger paths and auto-generated file list now match the actual workflow. LGTM.
2 participants
What does this PR do?
Documents the
sync-tool-docs.ymlworkflow in AGENTS.md:tools.json,README.md, andDOCS.mdare auto-regenerated on merge — no manualpython scripts/extract_tools.pyneededDiscovered during review of #871 where a contributor correctly pointed out that stale doc references are cleaned up automatically by this workflow.
Type of change
Testing
uv run pytest)uv run ruff check)Checklist