6.7 KiB
AGENTS.md
This file provides guidance to AI coding agents (Claude Code, Cursor, Copilot, Antigravity, etc.) when working with code in this repository.
Repository Overview
A collection of skills for Claude.ai and Claude Code for senior software engineers. Skills are packaged instructions and scripts that extend Claude and your coding agents capabilities.
OpenCode Integration
OpenCode uses a skill-driven execution model powered by the skill tool and this repository's /skills directory.
Core Rules
- If a task matches a skill, you MUST invoke it
- Skills are located in
skills/<skill-name>/SKILL.md - Never implement directly if a skill applies
- Always follow the skill instructions exactly (do not partially apply them)
Intent → Skill Mapping
The agent should automatically map user intent to skills:
- Feature / new functionality →
spec-driven-development, thenincremental-implementation,test-driven-development - Planning / breakdown →
planning-and-task-breakdown - Bug / failure / unexpected behavior →
debugging-and-error-recovery - Code review →
code-review-and-quality - Refactoring / simplification →
code-simplification - API or interface design →
api-and-interface-design - UI work →
frontend-ui-engineering
Lifecycle Mapping (Implicit Commands)
OpenCode does not support slash commands like /spec or /plan.
Instead, the agent must internally follow this lifecycle:
- DEFINE →
spec-driven-development - PLAN →
planning-and-task-breakdown - BUILD →
incremental-implementation+test-driven-development - VERIFY →
debugging-and-error-recovery - REVIEW →
code-review-and-quality - SHIP →
shipping-and-launch
Execution Model
For every request:
- Determine if any skill applies (even 1% chance)
- Invoke the appropriate skill using the
skilltool - Follow the skill workflow strictly
- Only proceed to implementation after required steps (spec, plan, etc.) are complete
Anti-Rationalization
The following thoughts are incorrect and must be ignored:
- "This is too small for a skill"
- "I can just quickly implement this"
- "I’ll gather context first"
Correct behavior:
- Always check for and use skills first
This ensures OpenCode behaves similarly to Claude Code with full workflow enforcement.
Orchestration: Personas, Skills, and Commands
This repo has three composable layers. They have different jobs and should not be confused:
- Skills (
skills/<name>/SKILL.md) — workflows with steps and exit criteria. The how. Mandatory hops when an intent matches. - Personas (
agents/<role>.md) — roles with a perspective and an output format. The who. - Slash commands (
.claude/commands/*.md) — user-facing entry points. The when. The orchestration layer.
Composition rule: the user (or a slash command) is the orchestrator. Personas do not invoke other personas. A persona may invoke skills.
The only multi-persona orchestration pattern this repo endorses is parallel fan-out with a merge step — used by /ship to run code-reviewer, security-auditor, and test-engineer concurrently and synthesize their reports. Do not build a "router" persona that decides which other persona to call; that's the job of slash commands and intent mapping.
See agents/README.md for the decision matrix and references/orchestration-patterns.md for the full pattern catalog.
Claude Code interop: the personas in agents/ work as Claude Code subagents (auto-discovered from this plugin's agents/ directory) and as Agent Teams teammates (referenced by name when spawning). Two platform constraints align with our rules: subagents cannot spawn other subagents, and teams cannot nest. Plugin agents silently ignore the hooks, mcpServers, and permissionMode frontmatter fields.
Creating a New Skill
Directory Structure
skills/
{skill-name}/ # kebab-case directory name
SKILL.md # Required: skill definition
scripts/ # Required: executable scripts
{script-name}.sh # Bash scripts (preferred)
{skill-name}.zip # Required: packaged for distribution
Naming Conventions
- Skill directory:
kebab-case(e.g.web-quality) - SKILL.md: Always uppercase, always this exact filename
- Scripts:
kebab-case.sh(e.g.,deploy.sh,fetch-logs.sh) - Zip file: Must match directory name exactly:
{skill-name}.zip
SKILL.md Format
---
name: { skill-name }
description:
{
One sentence describing when to use this skill. Include trigger phrases like "Deploy my app",
"Check logs",
etc.,
}
---
# {Skill Title}
{Brief description of what the skill does.}
## How It Works
{Numbered list explaining the skill's workflow}
## Usage
```bash
bash /mnt/skills/user/{skill-name}/scripts/{script}.sh [args]
```
Arguments:
arg1- Description (defaults to X)
Examples: {Show 2-3 common usage patterns}
Output
{Show example output users will see}
Present Results to User
{Template for how Claude should format results when presenting to users}
Troubleshooting
{Common issues and solutions, especially network/permissions errors}
### Best Practices for Context Efficiency
Skills are loaded on-demand — only the skill name and description are loaded at startup. The full `SKILL.md` loads into context only when the agent decides the skill is relevant. To minimize context usage:
- **Keep SKILL.md under 500 lines** — put detailed reference material in separate files
- **Write specific descriptions** — helps the agent know exactly when to activate the skill
- **Use progressive disclosure** — reference supporting files that get read only when needed
- **Prefer scripts over inline code** — script execution doesn't consume context (only output does)
- **File references work one level deep** — link directly from SKILL.md to supporting files
### Script Requirements
- Use `#!/bin/bash` shebang
- Use `set -e` for fail-fast behavior
- Write status messages to stderr: `echo "Message" >&2`
- Write machine-readable output (JSON) to stdout
- Include a cleanup trap for temp files
- Reference the script path as `/mnt/skills/user/{skill-name}/scripts/{script}.sh`
### Creating the Zip Package
After creating or updating a skill:
```bash
cd skills
zip -r {skill-name}.zip {skill-name}/
End-User Installation
Document these two installation methods for users:
Claude Code:
cp -r skills/{skill-name} ~/.claude/skills/
claude.ai: Add the skill to project knowledge or paste SKILL.md contents into the conversation.
If the skill requires network access, instruct users to add required domains at claude.ai/settings/capabilities.