skill-authoring
Skill49 starsChanged 6 months agoMITView on GitHub
Use when authoring, creating, refining, or troubleshooting agent skills — scaffold SKILL.md and frontmatter, write and optimize the trigger description, structure the body with progressive disclosure, validate structure, and test or debug activation. Also when building a new skill from scratch, when a skill won't trigger, loads incorrectly, or the agent ignores it entirely. Use when a skill misbehaved in the current session and needs adjustment based on learnings.
- Installs packages
89 other projects use a version of this.
Adopted by
Most recently taken up by
- neuroborus/agent-runnertheir own version, first seen Nov 8, 2026
- juninmd/skillstheir own version, first seen Nov 8, 2026
- TrueImmortal82/open-code-skillstheir own version, first seen Nov 8, 2026
- patrykmurzyn/skillstheir own version, first seen Nov 8, 2026
- frnkgns/Overgeared-Skillstheir own version, first seen Nov 8, 2026
- notivn/AIEVv2their own version, first seen Nov 8, 2026
Used with
Projects with it also use cloud-api-recipe-authoring, codebuddy-ide-mcp-upgrade and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
TencentCloudBaseSkillcloud-api-recipe-authoring
Author or revise a cloud-api-operations recipe (config/source/skills/cloud-api-operations/references/recipes/). Encodes why the long tail of control-plane capabilities is deliberately NOT wrapped as MCP/CLI tools, the API-first admission test for whether a capability deserves a recipe, the negative and positive lists, the fixed recipe structure, the writing rules distilled from writing-for-agents, the user-facing copy red lines, and the product regeneration/verification pipeline. Also routes contributors (and their agents) to the contribution flow and the pre-PR self-test protocol in references/contributing.md. Use when adding a recipe, judging whether a scenario belongs in the recipe set, updating the recipes index, re-checking existing recipes against the admission test, or onboarding someone who wants to submit one.
Also in 3 projects that use this
TencentCloudBaseSkillcodebuddy-ide-mcp-upgrade
升级 CodeBuddy IDE(genie 扩展)内置的 CloudBase MCP,以及 MCP 发版时同步 IDE 侧白名单。当用户提到「更新 IDE 里的 MCP」「内置 MCP 版本太老」「IDE 集成的 CloudBase 功能不足」「改工具白名单 toolWhiteList」「把新 bundle 打进 CodeBuddy」「白名单漂移」「MCP 发版要同步什么」时使用。覆盖:解包定位内置 bundle 与内嵌配置、重新构建 mcp bundle、生成新的工具白名单与系统提示词、安全注入 IDE 并备份、用 MCP 协议验证工具清单、人工端到端验收、一键回滚。
Also in 3 projects that use this
DIL8654Skillapi-contract-review
Review ASP.NET Core Web API contracts for HTTP semantics, versioning, backward compatibility, and response consistency. Use when the user asks to review an API, check endpoints, validate REST behavior, or before releasing contract changes.
Also in 5 projects that use this
zaxbysauceSkillpr-review-fix
Codex adapter for addressing pull request review feedback in opencode-swarm. Use when the user asks to fix PR review comments, requested changes, reviewer findings, CI-review notes, or a pasted review summary with low false-positive tolerance.
Also in 3 projects that use this
albertdobmeyerSkillgit-workflows
Advanced git operations beyond add/commit/push. Use when rebasing, bisecting bugs, using worktrees for parallel development, recovering with reflog, managing subtrees/submodules, resolving merge conflicts, cherry-picking across branches, or working with monorepos.
Also in 3 projects that use this
rogue-dev-studioSkillfrontend-engineering
Expert frontend application engineering: accessible UI structure, state and data-fetching discipline, form/validation UX, responsive layouts, performance budgets, and integration with API contracts. Use when building or refining SPA/web screens, design-system consumption, client-side routing, or fixing UI reliability (loading, empty, and error states).
Also in 3 projects that use this
- +6 more from TencentCloudBase
Other versions89 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 89
- nyldn/claude-octopus★ 4.4ksame name
- endurain-project/endurain★ 2.4ksame name
- joaovitoriasilva/endurain★ 2.4ksame name
- theopenco/llmgateway★ 1.7ksame name
- TencentCloudBase/CloudBase-AI-ToolKit★ 1.2ksame name
- TencentCloudBase/CloudBase-MCP★ 1.2ksame name
- TencentCloudBase/CloudBase-AI-Toolkit★ 1.2ksame name
- pockebot/openpocket★ 847same name
- QuixiAI/agi-memory★ 623same name
- QuixiAI/Hexis★ 623same name
79 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository26 other files it gives its agents.
- AGENTS.mdAGENTS.md
- coding-standardsSkill
- coolify-composeSkill
- crafting-effective-readmesSkill
- diataxisSkill
- english-pleaseSkill
- feature-planning-artifactsSkill
- frontend-design-principlesSkill
- grug-brained-devSkill
- html-artifactsSkill
- improveSkill
- improving-promptsSkill
- jjSkill
- reducing-entropySkill
- researching-codebasesSkill
- roadmapSkill
- roadmap-to-improve-plansSkill
- rustSkill
- salsaSkill
- strategic-roadmapSkill
- svelte5Skill
- sveltekitSkill
- writing-cli-skillsSkill
- writing-error-messagesSkill
- writing-plansSkill
- writingSkill
The file
We split this skill into the rules it gives an agent
9 rules. 0 are common, 9 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 80 edited versions we read keep these.
9
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Use this as the working playbook for skill creation and maintenance.
- Distinctive: line 35
Use the workflow files for new skills, source synthesis, debugging, testing, or any change that touches the skill's shape.
- Distinctive: line 66
Use this placement model:
- Distinctive: line 117
Write for an agent that can already reason.
- Distinctive: line 119
Use this shape by default:
- Distinctive: line 124
Guard: call out common mistakes, rationalizations, false positives, or edge cases.
- Distinctive: line 127
Prefer tables, checklists, templates, and input/output examples over explanatory prose.
- Distinctive: line 144
Do not split content just to look organized.
- Distinctive: line 178
When modifying or reviewing a skill, report:
“Common” is measured: kept by at least 6 in 10 of the 80 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Skill Authoring
Use this as the working playbook for skill creation and maintenance. Start by choosing the job below. Load only the files needed for that job.
Done means the skill loads for the right requests, gives clear instructions without bloating context, and records source evidence when domain accuracy matters.
Agents see name and description before they see the body. The body loads only after the description matches the task. References, scripts, and assets load only when needed. Write for that loading order.
Choose the Job
| Job | Read first | Then use when needed |
| Create a small skill from scratch | workflows/create.md | templates/simple.md, templates/router.md, references/patterns.md |
| Build or update a skill from docs, project history, examples, failures, or multiple sources | workflows/synthesize.md | README.md, references/examples.md |
| Review or audit an existing skill | references/rules.md | references/examples.md, spec/specification.md |
| Check whether a skill activates and behaves correctly | workflows/test.md | workflows/debug.md when activation fails |
| Diagnose a skill that will not trigger or is ignored | workflows/debug.md | spec/specification.md, references/rules.md |
| Improve a skill from a concrete session failure | workflows/refine.md | references/rules.md, workflows/test.md |
| Verify format constraints | spec/specification.md | Tooling |
Fast Path
For a localized edit, do not ritualize it:
- Inspect the skill and nearby conventions.
- Edit the smallest thing that fixes the issue.
- Validate structure and, when relevant, activation behavior.
- Report what changed and what remains uncertain.
Use the workflow files for new skills, source synthesis, debugging, testing, or any change that touches the skill's shape.
Cardinal Rules
| Rule | Why It Matters |
| Description has trigger keywords | Without them, the skill never activates |
| Description names capabilities and activation conditions, not steps | Agents may follow description shortcuts instead of loading the body |
| Description uses third person | It is injected as metadata, not spoken by the agent |
| Name matches directory | Required for skill loading |
| Critical instructions appear early | Long content may be skipped or deemphasized |
SKILL.md stays lean | Runtime context is limited |
References are directly linked from SKILL.md | Hidden chains are easy to miss |
| Source-backed guidance beats vibes | Real docs, history, fixes, and failures improve accuracy |
| Precision before addition | More files and prose often reduce reliability |
| Test activation before deployment | A skill that works but never triggers has zero value |
| Use agent-agnostic language by default | Skills should port across LLM agents unless intentionally provider-specific |
For the full impact-ranked rule list, read references/rules.md when reviewing, auditing, or tightening a skill.
Skill Shape
skill-name/
├── SKILL.md # Required entry point
├── README.md # Optional maintainer context for synthesized or complex skills
├── references/ # Optional focused docs loaded on demand
├── scripts/ # Optional executable helpers
└── assets/ # Optional templates, schemas, images, static filesUse this placement model:
| Content | Put it in |
| Frontmatter and core instructions | SKILL.md |
| Detailed optional guidance the agent may need | references/*.md |
| Deterministic repeatable operations | scripts/* |
| Templates, schemas, static examples | assets/* |
| Source inventory, trust level, decisions, gaps, changelog | README.md |
Provenance belongs in README.md unless the agent needs it to perform the task.
Description Requirements
The description decides whether the skill ever loads. Write it for discovery.
Use this formula:
description: Use when [triggering conditions] — [specific capabilities]. Handles [file types, contexts, symptoms, synonyms].Good:
description: Use when working with PDF files — extracts text, fills forms, merges documents. Handles .pdf files, scanned PDFs, and form fields.Bad:
description: Processes PDFs by first extracting text, then analyzing structure, then outputting results.Include:
- words users actually say
- file types and extensions
- error messages or symptoms
- synonyms and alternate phrasings
- negative/positive trigger distinctions when false positives matter
Exclude:
- step-by-step workflow summaries
- implementation details
- first-person language
- generic claims like "helps with documents"
Writing SKILL.md Bodies
Write for an agent that can already reason. Do not teach basics. Provide the facts, constraints, examples, and checks that change behavior.
Use this shape by default:
- Choose: identify the mode, path, or workflow quickly.
- Do: give imperative steps and decision points.
- Show: include one excellent concrete example or template.
- Guard: call out common mistakes, rationalizations, false positives, or edge cases.
- Check: name the validation command, evidence, or expected result.
Prefer tables, checklists, templates, and input/output examples over explanatory prose.
Progressive Disclosure
| Layer | What | When Loaded | Target |
| 1 | name + description | Always | Trigger-rich, concise |
| 2 | SKILL.md body | When skill triggers | Path choice + core rules |
| 3 | references/, scripts/, assets/ | On demand | Focused leaves with direct reasons |
Split content when:
SKILL.mdis becoming an encyclopedia- guidance is optional or domain-specific
- a reference has a clear "open when..." reason
- scripts can make a fragile task deterministic
Do not split content just to look organized.
Tooling
Script paths are relative to this skill directory.
Scaffold a skill:
python scripts/init.py my-skill
python scripts/init.py my-skill --router # for skills that route between sub-workflowsValidate a skill:
./scripts/validate.sh path/to/skillOr use the official validator:
pip install skills-ref
skills-ref validate path/to/skillValidation checks structure. It does not prove description quality, source coverage, or behavioral reliability.
Source Material
Vendored authoring approaches live under sources/ for deeper study. For this skill's source inventory, synthesis decisions, and gaps, read README.md.
Report Back
When modifying or reviewing a skill, report:
- Summary
- Changes made or findings
- Validation results
- Open gaps
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

