Description
Intelligently update README.md and keep it in sync with the code.
Trigger Conditions
- "Update README"
- Invoked by the git-precommit orchestrator
- After adding an important feature
Regulatory Basis
- Constitution: CONSTITUTION.md Article 6
Update Strategy
1. Detect change type
- New feature → Update feature list
- New dependency → Update installation instructions
- API change → Update usage examples
- Structural change → Update project structure
2. Update blocks
| Block | Condition |
|---|---|
| Feature list | Add/remove features |
| Installation instructions | Dependency changes |
| Usage examples | API changes |
| Project structure | Directory structure changes |
| Configuration instructions | New configuration options |
| Tool count | MCP tool changes |
⚠️ Tool count sync
When MCP tools are added or removed,you mustfirst run:
uv run python scripts/count_mcp_tools.py --update-docs
This script will automatically update the tool count and list in all documents, including:
- README.md / README.zh-TW.md (tool count)
- copilot-instructions.md (tool count + list)
- TOOLS_INDEX.md (complete tool index)
- instructions.py (embedded tool list in MCP Server)
- pubmed-mcp-tools-reference SKILL (complete tool reference)
3. Preserve blocks
The following blocks are not automatically modified:
- License information
- Contribution guidelines
- Acknowledgments
Output format
📝 README 更新分析
變更偵測：
✅ 新增功能：用戶認證模組
✅ 新增依賴：bcrypt
建議更新：
[功能列表] 新增「🔐 用戶認證」
[安裝說明] 新增 bcrypt 安裝指令
預覽：
## 功能
- 🤖 Claude Skills
- 📝 Memory Bank
+ - 🔐 用戶認證（新增）