agentleFS
kynn-devkynn-dev/agent-skills/.agents/skills/skill-authoring/SKILL.md

skill-authoring

Skill1 starsChanged 46 days agoMITView on GitHub

Use when creating, evaluating, or revising an agent skill, including frontmatter, trigger boundaries, progressive disclosure, references, scripts, and activation tests; do not use for ordinary application documentation, prompt-only rewrites, or executing a skill's domain workflow.

89 other projects use a version of this.

Adopted by

Most recently taken up by

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.
  • TencentCloudBaseSkill

    cloud-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

  • TencentCloudBaseSkill

    codebuddy-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

  • DIL8654Skill

    api-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

  • zaxbysauceSkill

    pr-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

  • albertdobmeyerSkill

    git-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-studioSkill

    frontend-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

The file

Show its rules and text

We split this skill into the rules it gives an agent

19 rules. 0 are common, 15 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 80 edited versions we read keep these.

  • 15

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create skills that are discoverable, narrowly routed, operationally useful, and maintainable.

    line 8
  2. Distinctive:

    Start from representative user requests, the desired observable outcome, nearby requests that must not trigger the skill, allowed side …

    line 18
  3. Distinctive:

    Keep the skill operational.

    line 32
  4. Distinctive:

    keep descriptions discriminating and concise.

    line 40
  5. Distinctive:

    test explicit requests, natural-language variants, implicit requests, near misses, and ambiguous prompts.

    line 41
  6. Distinctive:

    keep only supported optional frontmatter fields.

    line 72
  7. Distinctive:

    put purpose, workflow, constraints, outputs, and validation in the Markdown body rather than hiding them in metadata.

    line 73
  8. Very specific:

    keep the human README explanatory and link it to SKILL.md as the operational source of truth.

    line 74
  9. Very specific:

    Keep SKILL.md concise enough to load for every matching request.

    line 79
  10. Very specific:

    Add references/ only when a focused body would otherwise omit material rules, schemas, domain tables, or mode-specific procedures.

    line 81
  11. Very specific:

    Add scripts/ only when deterministic execution or repeated transformation materially improves reliability.

    line 83
  12. Distinctive:

    Do not create empty resource directories, placeholder examples, or copied manuals without a concrete packaging requirement.

    line 85
  13. Distinctive:

    Use imperative, evidence-oriented instructions.

    line 89
  14. Distinctive:

    Avoid generic advice that the host already enforces, repetitive policy text, speculative edge cases, and fixed steps where multiple safe …

    line 100
  15. Distinctive:

    Use a small realistic evaluation matrix rather than checking whether headings or keywords appear:

    line 104
  16. Distinctive:

    Run the package validator, then perform a scoped link/content audit:

    line 118
  17. Distinctive:

    every relative Markdown link inside the skill resolves.

    line 126
  18. Distinctive:

    no secret, cookie, key, token, or environment value was read, printed, or persisted.

    line 131
  19. Distinctive:

    When real evaluation exposes a false positive, false negative, stale instruction, or unnecessary resource, make the smallest supported …

    line 138

“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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Skill authoring

Create skills that are discoverable, narrowly routed, operationally useful, and maintainable. Treat a skill as a small contract: its description routes requests, its body defines the common workflow, and optional resources supply only the detail needed for a specific mode.

Operational contract

Objective

Turn a recurring agent behavior into a reusable, testable skill with a discriminating trigger, explicit exclusions, a compact operational contract, progressive disclosure, and realistic activation evidence. The result should be easier to route and maintain than a giant one-off prompt.

Expected inputs

Start from representative user requests, the desired observable outcome, nearby requests that must not trigger the skill, allowed side effects, risk/authorization boundaries, host capabilities, existing skill/package conventions, and any public/private packaging constraints.

Required outputs

Produce or revise the skill's SKILL.md, the human-facing README.md when the package requires one, justified references/scripts only when needed, positive and exclusion activation cases, validation evidence, and a handoff that records assumptions, limitations, and unresolved gaps.

Definition of done

A skill is done only when its directory/frontmatter are valid, the human and agent documents agree on scope, trigger and exclusion cases behave as intended, local links/resources resolve, scripts or references have real callers, public-safety constraints pass, and structural validation is clearly distinguished from behavioral evaluation.

Authoring contract

Before writing, record the intended user request, desired observable outcome, in-scope actions, exclusions, side effects, risk boundary, and the host capabilities the skill may rely on. Preserve the user's requested location and authorization. Do not install or activate a skill globally as an implicit part of authoring.

Keep the skill operational. Do not write identity claims, role-play instructions, or instructions that depend on hidden activation state. Replace provider/runtime assumptions with portable file/tool behavior, explicit capability checks, or a documented NOT_RUN condition whenever practical.

Trigger and exclusion design

Define both positive and negative routing before drafting the body:

  • positive triggers describe the actual intent, artifact, or decision that requires this skill;
  • exclusions name nearby work that should be handled directly or by another skill;
  • keep descriptions discriminating and concise;
  • test explicit requests, natural-language variants, implicit requests, near misses, and ambiguous prompts.

An ambiguous case should route to clarification or a safer boundary rather than trigger an expansive workflow.

Required file and frontmatter shape

In this package, every public skill directory contains both a human guide and an agent contract:

.agents/skills/<skill-name>/
├── README.md   # human-facing explanation
├── SKILL.md    # executable agent contract
├── references/ # optional, only when progressive disclosure helps
└── scripts/    # optional, only when deterministic execution helps

Other hosts may only require SKILL.md; follow the host's packaging contract. When working in this repository, README.md and SKILL.md are both required and must not become competing sources of truth.

Minimum SKILL.md frontmatter:

---
name: skill-name
description: Use when <specific trigger>; do not use for <nearby exclusion>.
---

Apply these checks:

  • name is lowercase kebab-case and matches the directory name exactly;
  • description contains a real trigger boundary and useful exclusion;
  • keep only supported optional frontmatter fields;
  • put purpose, workflow, constraints, outputs, and validation in the Markdown body rather than hiding them in metadata;
  • keep the human README explanatory and link it to SKILL.md as the operational source of truth;
  • preserve unrelated established frontmatter when revising an existing skill.

Progressive disclosure

Keep SKILL.md concise enough to load for every matching request. It should contain shared purpose, routing boundary, essential invariants, normal workflow, and links to conditional detail.

Add references/ only when a focused body would otherwise omit material rules, schemas, domain tables, or mode-specific procedures. Link each reference from the section where it is needed and state when to read it.

Add scripts/ only when deterministic execution or repeated transformation materially improves reliability. A script must have a narrow interface, avoid hidden side effects/secrets, and be executed in validation. Do not add scripts that merely restate prose or wrap a one-off command.

Do not create empty resource directories, placeholder examples, or copied manuals without a concrete packaging requirement. Every relative link must resolve inside the skill package and every resource must have a caller.

Write the operational body

Use imperative, evidence-oriented instructions. Include only decisions that change behavior or protect a real boundary:

  1. state when the skill applies and when it yields to another workflow;
  2. define the smallest useful workflow, including required inputs, ownership, side effects, and stop conditions;
  3. identify evidence/artifacts that prove each material result;
  4. distinguish PASS, FAIL, NOT_RUN, and BLOCKED_EXTERNAL;
  5. define a stable output/handoff contract when another worker or skill consumes the result;
  6. preserve existing architecture and user scope.

For this package, include the operational-contract summary headings ### Objective, ### Expected inputs, ### Required outputs, and ### Definition of done so another agent can understand the contract before reading the full workflow.

Avoid generic advice that the host already enforces, repetitive policy text, speculative edge cases, and fixed steps where multiple safe approaches are equivalent.

Evaluate activation and behavior

Use a small realistic evaluation matrix rather than checking whether headings or keywords appear:

CaseExpected resultEvidence
Direct positive requestSkill activates and follows intended boundaryObserved routing/output
Natural-language variantActivates without exact wordingObserved routing/output
Relevant but implicit requestActivates only when outcome needs itObserved routing/output
Near miss/excluded requestDoes not activate or routes saferObserved non-activation/routing
Missing capability/dependencyReports NOT_RUN/BLOCKED_EXTERNAL without fabricating successSanitized blocker evidence

For a new or materially revised skill, test at least one positive case and one exclusion case. Give the evaluator only the realistic request and minimum relevant artifacts; do not seed the intended answer.

Local validation

Run the package validator, then perform a scoped link/content audit:

python -B tools/validate_skills.py .

The validator proves structural constraints only. Also verify that:

  • every relative Markdown link inside the skill resolves;
  • the description has both a discriminating trigger and an exclusion;
  • the human README and agent contract agree on purpose and scope;
  • references/scripts are justified and linked;
  • activation cases cover positive and exclusion prompts;
  • no secret, cookie, key, token, or environment value was read, printed, or persisted;
  • changed scripts, when any, run successfully within documented scope.

Record each check as PASS, FAIL, NOT_RUN, or BLOCKED_EXTERNAL. A validator exit of zero does not prove useful routing behavior.

Revision and removal rules

When real evaluation exposes a false positive, false negative, stale instruction, or unnecessary resource, make the smallest supported correction. Re-test the affected trigger and its nearest exclusion. Remove obsolete references, scripts, provider assumptions, hooks, and installation instructions instead of preserving them for historical familiarity.

End the authoring handoff with the skill path, changed resources, trigger/exclusion cases, validation commands/states, assumptions, unresolved risks, and next action.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.