skills.rest
UniClipboard
UniClipboardOFFICIAL
Explore all skills by this author →
GitHub

refresh-agents

Updates fact-based sections of AGENTS.md from current codebase state.

1.6k|73|Updated Mar 13, 2025
Search Tags:#codebase#Git#maintenance#Rust#Refactoring#Documentation#Agents.md
One-click install
npx skills add https://github.com/UniClipboard/UniClipboard --skill refresh-agents
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: refresh-agents
Source: https://github.com/UniClipboard/UniClipboard/tree/main/.agents/skills/refresh-agents
Command: npx skills add https://github.com/UniClipboard/UniClipboard --skill refresh-agents

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Agent-facing documentation like AGENTS.md drifts out of sync with the codebase after refactors, renames, and crate changes, causing AI agents and developers to follow stale paths and outdated structural information.

Core Features & Use Cases

  • Structure Sync: Runs a pre-commit script to refresh the crate inventory in the STRUCTURE section after adding or removing crates.
  • Entry Point Verification: Validates every path in the WHERE TO LOOK table against the actual filesystem, updating moved files and removing dead references.
  • Hotspot Detection: Computes complexity hotspots using git churn and file size metrics to highlight large, frequently changed files.
  • Use Case: After renaming several core modules during a refactor, run this Skill to verify all AGENTS.md paths, recompute complexity hotspots, update the datestamp, and commit the refreshed documentation.

Quick Start

Ask the agent to refresh the fact-based sections of crates/AGENTS.md so they match the current codebase state.

Frequently Asked Questions about refresh-agents

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep AGENTS.md documentation in sync with my codebase?▼

Run this refresh workflow after structural changes. It syncs the crate inventory via a pre-commit script, verifies every path in the WHERE TO LOOK table still exists, and recomputes complexity hotspots from git history.

When should I refresh agent documentation files?▼

Refresh after adding or removing crates, moving or renaming key files, before milestones, or whenever you notice AGENTS.md referencing stale paths during a session. The KNOWN BROKEN section only needs updating when tests fail on HEAD.

How do I find complexity hotspots in a Rust workspace?▼

Combine git churn with file size: run git log over recent commits to count change frequency per file, then use wc -l on Rust sources to find files over 300 lines. Files that are both large and frequently changed are the true hotspots.

Which sections of AGENTS.md should not be manually refreshed?▼

Leave OVERVIEW, CONVENTIONS, ANTI-PATTERNS, COMMANDS, and NOTES alone. CONVENTIONS and ANTI-PATTERNS are maintained by a separate learn skill, and the others only change on major architecture or build system shifts.

What are the limitations of automated documentation refresh?▼

It only updates fact-based sections like structure, paths, and hotspots; it cannot judge narrative accuracy or architectural intent. Sections like OVERVIEW still require human judgment when the architecture fundamentally changes.

Related Skills

Explore More Software Engineering Skills→
ryan-mahoneyryan-mahoney

agents-update

Generate or update AGENTS.md files mapping repository architecture for coding agents.

Community
Advanced
scooter-lacroixscooter-lacroix
8

create_handoff

Create a YAML handoff document summarizing session progress, decisions, and next steps.

Community
Intermediate
zyrrezyrre

insight

Record architectural decisions and coding insights into AGENTS.md with categorized sections.

Community
Intermediate
PotLockPotLock

diffs

Generate shareable diffs from before/after text or patch strings.

Official
Intermediate