
Skill Sync
FreeAutomatically updates AGENTS.md with skill metadata.
Free · Opens the source repo
What Skill Sync does
Skill Sync is a Bash script designed to streamline the process of maintaining consistency between skill metadata and the AGENTS.md files in your project. When you create or modify a skill, it is essential to ensure that the corresponding Auto-invoke sections in AGENTS.md are up to date. This tool automates that task, saving you time and reducing the risk of human error. By running the sync script, you can easily generate and update the Auto-invoke tables based on the metadata you've defined for your skills.
The script works by reading all SKILL.md files in the specified directory, extracting the necessary metadata fields such as scope and auto_invoke, and then updating the relevant AGENTS.md files accordingly. This ensures that any changes you make to skill metadata are reflected in the documentation that users rely on to understand how to invoke your skills. The tool supports multiple scopes, allowing you to target specific AGENTS.md files based on the context of your skills, whether they are related to UI, API, SDK, or other areas.
Skill Sync is particularly useful for developers and teams who frequently update or create new skills. By integrating this tool into your workflow, you can maintain accurate documentation without the tedious manual updates that often accompany skill development. It is a straightforward solution that enhances productivity and ensures that your skills are always correctly represented in the project documentation.
In summary, Skill Sync is an essential tool for anyone involved in skill development who wants to keep their AGENTS.md files synchronized with the latest skill metadata. It simplifies the maintenance of documentation, allowing you to focus on building and improving your skills instead of worrying about keeping track of updates.
When to use it
Use this tool after creating or modifying skills to ensure documentation is accurate and up to date.
When not to use it
This skill is not suitable for projects that do not utilize AGENTS.md files or do not require synchronization of skill metadata.
What you can build with it
After Skill Creation
Run the sync script immediately after creating a new skill to ensure its details are reflected in AGENTS.md.
Updating Skill Metadata
Whenever you modify the metadata of an existing skill, use Skill Sync to keep the documentation current.
Batch Updates
If you have multiple skills to update, run the sync script to refresh all relevant AGENTS.md files in one go.
How to install Skill Sync
View source1. Install with the skills CLI
npx skills add prowler-cloud/prowler/skill-sync --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by prowler-cloudPurpose
Keeps AGENTS.md Auto-invoke sections in sync with skill metadata. When you create or modify a skill, run the sync script to automatically update all affected AGENTS.md files.
Required Skill Metadata
Each skill that should appear in Auto-invoke sections needs these fields in metadata.
auto_invoke can be either a single string or a list of actions:
metadata:
author: prowler-cloud
version: "1.0"
scope: [ui] # Which AGENTS.md: ui, api, sdk, root
# Option A: single action
auto_invoke: "Creating/modifying components"
# Option B: multiple actions
# auto_invoke:
# - "Creating/modifying components"
# - "Refactoring component folder placement"
Scope Values
| Scope | Updates |
|---|---|
root | AGENTS.md (repo root) |
ui | ui/AGENTS.md |
api | api/AGENTS.md |
sdk | prowler/AGENTS.md |
mcp_server | mcp_server/AGENTS.md |
Skills can have multiple scopes: scope: [ui, api]
Usage
After Creating/Modifying a Skill
./skills/skill-sync/assets/sync.sh
What It Does
- Reads all
skills/*/SKILL.mdfiles - Extracts
metadata.scopeandmetadata.auto_invoke - Generates Auto-invoke tables for each AGENTS.md
- Updates the
### Auto-invoke Skillssection in each file
Example
Given this skill metadata:
# skills/prowler-ui/SKILL.md
metadata:
author: prowler-cloud
version: "1.0"
scope: [ui]
auto_invoke: "Creating/modifying React components"
The sync script generates in ui/AGENTS.md:
### Auto-invoke Skills
When performing these actions, ALWAYS invoke the corresponding skill FIRST:
| Action | Skill |
|--------|-------|
| Creating/modifying React components | `prowler-ui` |
Commands
# Sync all AGENTS.md files
./skills/skill-sync/assets/sync.sh
# Dry run (show what would change)
./skills/skill-sync/assets/sync.sh --dry-run
# Sync specific scope only
./skills/skill-sync/assets/sync.sh --scope ui
Checklist After Modifying Skills
- Added
metadata.scopeto new/modified skill - Added
metadata.auto_invokewith action description - Ran
./skills/skill-sync/assets/sync.sh - Verified AGENTS.md files updated correctly
Frequently asked questions about Skill Sync
Similar skills
Markdown to HTML Conversion
Efficiently convert Markdown documents to HTML.
Code Tour
Create structured walkthroughs for codebases.
Acquire Codebase Knowledge
Streamline onboarding with comprehensive codebase documentation.
Documentation & Modernization
Streamline codebase documentation and modernization planning.
Azure Resource Visualizer
Generate architecture diagrams for Azure resources.
CLAUDE.md Improver
Optimize your CLAUDE.md files for better project context.
