Agent skill
readme-sync
Synchronizes the list of Agent Skills in the root README.md with the actual skills present in the codebase.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/readme-sync
SKILL.md
README Sync
Purpose
Ensures that the ## Agents and ## Agent Skills sections in the root README.md accurately reflect all available agents in agents/ and skills in skills/.
Workflow
- Identify Items:
- Locate all agents: Files ending in
.mdinagents/(excluding.gitkeep). - Locate all skills: Directories in
skills/containing aSKILL.mdfile.
- Locate all agents: Files ending in
- Extract Information:
- For skills: Use
uv run skills-ref read-properties <skill-directory>to get thenameanddescription. - For agents: Read the YAML frontmatter directly from the
.mdfile to extractnameanddescription.
- For skills: Use
- Generate Markdown: Format the collected information as sorted lists:
- Format:
- **[name](relative/path/to/item)**: description - Note: For agents, the link should point to the
.mdfile. For skills, the link should point to the directory.
- Format:
- Update README.md:
- Replace content between
<!-- START-AGENTS -->and<!-- END-AGENTS -->with the agents list. - Replace content between
<!-- START-SKILLS -->and<!-- END-SKILLS -->with the skills list.
- Replace content between
Implementation Notes
- The
skills-reftool is used for skills inskills/. - For agents in
agents/, extract thenameanddescriptionfrom the YAML frontmatter (lines between---). - Always maintain alphabetical order of the items in each section.
- Ensure the relative paths in the markdown links correctly point to the items from the root.
- Do not include items from
.cursor/skills/or.cursor/agents/.
Examples
Scenario: Updating README.md after adding a new skill
- Find all skills in the directory
skills/. - Get properties for each skill:
uv run skills-ref read-properties skills/claude-code-cli. - Update
README.mdwithin the<!-- START-SKILLS -->block.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?