skill-author

name	skill-author
version	1.0.0
description	Author a well-formed SKILL.md with valid AutoVault frontmatter, a helpful description, and correct capability declarations. Walks the schema section by section with a template and checklist.
license	MIT
tags	["authoring","skills","autovault","meta","demo"]
agents	["claude-code","codex","autojack"]
category	meta
tools_required	["Read","Edit","Write"]
capabilities	{"network":false,"filesystem":"readwrite","tools":["Read","Edit","Write"]}

Skill Author

Guide an author through producing a SKILL.md that will pass AutoVault's validation gate on the first submission.

When to use

• The user wants to create a new skill from scratch.
• The user has a workflow they want to package as a curated skill.
• An agent is about to call propose_skill and needs to compose valid frontmatter.

Before starting, call search_skills through AutoVault. If a similar skill already exists, reuse or extend it instead of creating a duplicate.

Required frontmatter

---
name: kebab-case-name           # letters, digits, hyphens, underscores
description: At least 20 characters explaining WHAT the skill does and WHEN to use it.
---

• name must match the storage directory name and be unique in the library.
• description is what search_skills ranks on and what agents read to decide whether the skill applies. Describe both what and when.

Recommended frontmatter

license: MIT
tags: [topic, tool, domain]
category: <one-word-bucket>
metadata:
  version: "1.0.0"
capabilities:
  network: false | true
  filesystem: readonly | readwrite
  tools: [Bash, Read, Edit, ...]
requires-secrets:
  - name: GITHUB_TOKEN
    description: Required for gh CLI calls.
    required: true
bin:
  setup:
    command: bin/setup
    description: Configure secrets in the host keychain.
    requires-tty: true

How to think about capabilities

AutoVault cross-checks the capabilities block against the skill body. Declare the minimum your skill actually needs — overstating is wasted surface area, understating will get the skill blocked at install time.

Field	Set this when
network: true	The skill makes HTTP calls (curl, wget, fetch, SDK clients).
filesystem: readwrite	The skill writes files anywhere on disk.
tools: [Bash]	Shell commands are the only execution path.
tools: [Bash, Read, Edit]	Shell + the agent's own file editors are used.

If your skill contains curl but you declare network: false, AutoVault will reject the install. Same for python commands under a tools: [Bash] declaration, or echo foo > ~/.bashrc under filesystem: readonly.

capabilities.{network, filesystem, tools} describes the whole bundle — SKILL.md AND every resource file (including bin/ scripts). The cross-check runs the network/filesystem/tools patterns over each shipped file, so a skill whose bin/setup makes HTTP calls must declare network: true even if the agent itself never makes a network call. The reason: at install time the user has no practical way to audit every line of every script before running setup, and a silent capability gap turns the declaration into a UX trap (a skill declaring network: false while shipping a bin/setup that fetches and pipes a remote installer into a shell is exactly what this would have hidden). Declare honestly for what runs end-to-end; the agent is still responsible for confirming the action surface at use time.

How to think about bin

Use a bin block when the skill needs out-of-band setup that handles secrets (API keys, OAuth tokens, host config files). Each entry declares a script that the user invokes from their own terminal:

autovault skill setup my-skill
autovault skill verify my-skill
autovault skill rotate-key my-skill

The agent never sees the secret — it just instructs the user to run the command. Action names follow ^[a-z][a-z0-9-]*$. setup is the convention, but any action name (verify, doctor, uninstall, rotate-key, …) is fine.

Field	Meaning
command	Path to a script under the skill directory. Validated via the same path-safety check that resources[] uses — no traversal, no absolute paths.
args	Optional array of strings passed verbatim to execve. No shell parsing, no globbing.
description	One-line summary printed by autovault skill list (planned).
requires-tty	Declarative metadata for the action. The current CLI always requires an interactive terminal for every bin action, even when this is false.

Files referenced by command must be supplied as resources (in propose_skill({ resources: [...] }) or fetched alongside SKILL.md by the GitHub adapter). Declared bin commands are written with mode 0o755 and covered by the same Ed25519 signature manifest as SKILL.md — the CLI verifies the signature before exec and refuses to run on mismatch.

requires-secrets should describe secrets only when the agent itself needs them. When the bin script is the only consumer, leave requires-secrets: [].

OAuth and browser setup UX

Many setup actions need a browser-based OAuth, API-key, or dashboard flow. Do not open the browser before the terminal has explained what is happening. The setup script should:

1. Print the purpose, required permissions, storage location, and secret boundary first.
2. Print every URL the user may need.
3. Ask before opening the browser.
4. Support AUTOVAULT_BROWSER_MODE:
   • prompt or unset: print URLs, then ask Open these pages in your browser now? [Y/n]:.
   • never, manual, no, false, or 0: never open a browser; print URLs only.
   • always, open, yes, true, or 1: open after printing URLs.
5. Offer a token/manual path for headless users when the provider supports it.

Prefer device-code or pairing-code flows when available: they keep the terminal as the source of truth, work over SSH, and avoid surprising browser focus steals. If the provider only supports dashboard/API-key setup, print the URL and required scopes before prompting to open it.

Full template

---
name: my-new-skill
description: One or two sentences that describe what the skill does and when an agent should trigger it.
license: MIT
tags: [domain, tool]
category: general
metadata:
  version: "1.0.0"
capabilities:
  network: false
  filesystem: readonly
  tools: [Bash]
---

# My New Skill

## When to use

- List the concrete triggers: user phrases, context shapes, preconditions.

## Prerequisites

- Tools the environment must have (git, gh, node, specific binaries).
- State the skill assumes (a repo, staged changes, an open PR, etc.).

## Workflow

Number the steps. Each step should be something a reader can execute
without referring back to this document.

### 1. First step

### 2. Second step

## Output

What the agent should produce (a draft message, a report, a fix, etc.).

## Anti-patterns

Things the skill should NOT do, so readers don't over-apply it.

Pre-submission checklist

• name is unique, kebab-case, matches the directory name.
• description is ≥ 20 characters and covers both what and when.
• capabilities honestly reflects the skill body (no mismatches).
• The workflow section is step-numbered and self-contained.
• No secrets, tokens, or credentials in the body.
• No denylisted pattern categories in executable examples: reads of SSH or AWS credentials, piping remote content into a shell, destructive recursive deletes of $HOME or root, unsanitized evaluation of shell variables, verification-bypass flags on git or TLS, setuid/setgid chmod, or obfuscated (base64/hex) shell execution. See scripts/security/patterns.json for the full list. The same denylist applies to every file in resources[] — including bin scripts.
• If a bin block is declared, every bin.<action>.command resolves to a file shipped in resources[].
• A "when to use" section explains triggers.
• An "anti-patterns" or "when NOT to use" section prevents misapplication.

Submitting

From an MCP-connected agent:

propose_skill({ skill_md: "<the full SKILL.md content>" })

Handle the outcome:

• accepted — stored. Note the dedup.tier in the response; if it's functional, the response tells you which existing skill is similar.
• duplicate — inspect existing_match. Pick a merge_options value (keep_existing, replace, merge, keep_both) and resubmit or abandon.
• invalid — the errors[] array lists the schema violations. Fix them and resubmit.
• security_blocked — security_flags[] explains which patterns or capability mismatches fired. Rewrite the body or correct the capabilities block, then resubmit.

Anti-patterns to avoid

• Descriptions that only say what, not when ("Audit code" vs. "Audit code for common security issues when the user asks for a pre-PR review").
• Over-broad capabilities just in case — this weakens the cross-check's value and blocks your skill from being trusted in restricted contexts.
• Burying the workflow in prose. Steps should be numbered and scannable.
• Copy-pasting another skill without adapting the name and description — dedup will catch it as exact or near_exact and reject the submit.