diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..23cd285 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,35 @@ +# AGENTS.md + +Guidance for AI coding agents working in this repository. + +## What this repository is + +A collection of skills for AI coding agents working with the Pro Cycling Manager game. Skills are packaged instructions and scripts that extend agent capabilities. + +## Creating a New Skill + +Skills follow the [Agent Skills](https://agentskills.io/) format, so they work with any agent that reads it. + +Prefer the `/skill-creator:skill-creator` skill (if available in your agent environment, otherwise skip this step) to create a new skill (or to edit and +improve an existing one). It walks through capturing intent, drafting `SKILL.md`, running +test prompts, and optimizing the description for reliable triggering. Then apply the +repository conventions below to the result. + +### Directory Structure + +``` +skills/ + {skill-name}/ # kebab-case directory name + SKILL.md # Required: skill definition + scripts/ # Optional: executable scripts + {script-name}.sh # Bash scripts + {script-name}.mjs # Node scripts + references/ # Optional: supporting docs loaded on demand + lib/ # Optional: shared code for scripts +``` + +### Naming Conventions + +- **Skill directory**: `kebab-case` (e.g., `pcm-db-editor`) +- **SKILL.md**: Always uppercase, always this exact filename +- **Scripts**: `kebab-case.sh` or `kebab-case.mjs` (e.g., `open-cdb.sh`) diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/README.md b/README.md index fdbbd36..1e0e157 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,6 @@ Each skill contains: ## Resources -- [cdb-converter](https://github.com/PCMStack/converter) — lossless `.cdb` ↔ SQLite converter -- [pcm-mcp](https://github.com/PCMStack/mcp) — MCP server for Pro Cycling Manager saves -- [Agent Skills](https://agentskills.io/) — the skill format used here +- [cdb-converter](https://github.com/PCMStack/converter) — Convert Pro Cycling Manager CDB files to/from SQLite. +- [pcm-mcp](https://github.com/PCMStack/mcp) — MCP server for querying and editing Pro Cycling Manager game databases +- [Agent Skills](https://agentskills.io/) — The skill format used here