You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fail_check "PR format" "PR title must start with \`[recipes]\`, \`[schemas]\`, \`[dashboards]\`, \`[integrations]\`, \`[primitives]\`, \`[extensions]\`, or \`[docs]\` followed by a space and description"
332
+
fail_check "PR format" "PR title must start with \`[recipes]\`, \`[schemas]\`, \`[dashboards]\`, \`[integrations]\`, \`[skills]\`, \`[primitives]\`, \`[extensions]\`, or \`[docs]\` followed by a space and description"
Copy file name to clipboardExpand all lines: CLAUDE.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This file helps AI coding tools (Claude Code, Codex, Cursor, etc.) work effectiv
4
4
5
5
## What This Repo Is
6
6
7
-
Open Brain is a persistent AI memory system — one database (Supabase + pgvector), one MCP protocol, any AI client. This repo contains the extensions, recipes, schemas, dashboards, and integrations that the community builds on top of the core Open Brain setup.
7
+
Open Brain is a persistent AI memory system — one database (Supabase + pgvector), one MCP protocol, any AI client. This repo contains the extensions, recipes, schemas, dashboards, integrations, and skills that the community builds on top of the core Open Brain setup.
8
8
9
9
**License:** FSL-1.1-MIT. No commercial derivative works. Keep this in mind when generating code or suggesting dependencies.
10
10
@@ -17,8 +17,9 @@ recipes/ — Standalone capability builds. Open for community contributio
skills/ — Reusable AI client skills and prompt packs. Open.
20
21
docs/ — Setup guides, FAQ, companion prompts.
21
-
resources/ — Claude Skill, companion files.
22
+
resources/ — Official companion files and packaged exports.
22
23
```
23
24
24
25
Every contribution lives in its own subfolder under the right category and must include `README.md` + `metadata.json`.
@@ -33,7 +34,7 @@ Every contribution lives in its own subfolder under the right category and must
33
34
34
35
## PR Standards
35
36
36
-
-**Title format:**`[category] Short description` (e.g., `[recipes] Email history import via Gmail API`)
37
+
-**Title format:**`[category] Short description` (e.g., `[recipes] Email history import via Gmail API`, `[skills] Panning for Gold standalone skill pack`)
|`skills/`| Reusable AI client skills and prompt packs | Meeting triage assistant, code review protocol, transcript processor | Open |
33
34
34
-
### Extensions vs Primitives vs Recipes
35
+
### Extensions vs Primitives vs Recipes vs Skills
35
36
36
37
-**Extensions** are curated, ordered builds that form a progressive learning path. Each teaches new concepts through practical use. They include database schemas, MCP server code, and step-by-step instructions. If you want to propose a new extension, [open an issue](../../issues/new?template=extension-submission.yml) first.
37
38
-**Primitives** are reusable concept guides that get referenced by multiple extensions. They teach a pattern (like RLS or shared access) once, so extensions can link to them instead of re-explaining. A primitive should be referenced by at least 2 extensions. [Propose one here](../../issues/new?template=primitive-submission.yml).
38
39
-**Recipes** are standalone builds — they add a capability without being part of the learning path. No ordering, no prerequisites beyond a working Open Brain. Open for community contributions.
40
+
-**Skills** are standalone agent behaviors packaged as plain-text prompt/skill files. They are smaller than recipes: no full build required, just a reusable behavior you can install into Claude Code, Codex, Cursor, or a similar client. Open for community contributions.
39
41
40
42
Not sure where yours fits? Open a discussion issue first.
41
43
42
44
## Required Files
43
45
44
-
Every contribution lives in its own subfolder under the right category (e.g., `recipes/my-cool-recipe/`) and must include:
46
+
Every contribution lives in its own subfolder under the right category (e.g., `recipes/my-cool-recipe/` or `skills/my-cool-skill/`) and must include:
45
47
46
48
-**`README.md`** — What it does, prerequisites, step-by-step setup, expected outcome, troubleshooting
47
49
-**`metadata.json`** — Structured metadata (see template below)
@@ -130,6 +132,13 @@ grant select, insert, update, delete on table public.your_table to service_role;
130
132
**Primitives** additionally require:
131
133
-**"Extensions That Use This"** section listing which extensions reference this primitive
132
134
135
+
**Skills** additionally require:
136
+
- At least one plain-text skill artifact (`SKILL.md`, `*.skill.md`, or `*-skill.md`)
137
+
-**"Supported Clients"** section listing which AI tools the skill is designed for
138
+
-**"Installation"** steps showing exactly where the file goes
139
+
-**"Trigger Conditions"** explaining when the skill should fire
140
+
- Plain-text, reviewable source files only. Do not submit zipped/exported skill bundles in `skills/`.
141
+
133
142
Check the `_template/` folder in each category for a starter README. The extension template contains HTML comments with detailed instructions for both human contributors and AI assistants.
134
143
135
144
## metadata.json
@@ -201,6 +210,7 @@ Example for an extension:
201
210
- Example: `[schemas] CRM contacts table with interaction tracking`
- Example: `[skills] Panning for Gold standalone skill pack`
204
214
205
215
**Description must include:**
206
216
- What the contribution does
@@ -239,13 +249,13 @@ Non-code contributions count at every level. Testing recipes, mentoring non-tech
239
249
240
250
Every PR is checked against these rules. All must pass before human review.
241
251
242
-
1.**Folder structure** — Contribution is in the correct category directory (`recipes/`, `schemas/`, `dashboards/`, `integrations/`, `primitives/`, `extensions/`)
252
+
1.**Folder structure** — Contribution is in the correct category directory (`recipes/`, `schemas/`, `dashboards/`, `integrations/`, `skills/`, `primitives/`, `extensions/`)
243
253
2.**Required files** — Both `README.md` and `metadata.json` exist in the contribution folder
244
254
3.**Metadata valid** — `metadata.json` parses as valid JSON and contains all required fields
245
255
4.**No credentials** — No API keys, tokens, passwords, or secrets in any file
246
256
5.**SQL safety** — No `DROP TABLE`, `DROP DATABASE`, `TRUNCATE`, or unqualified `DELETE FROM`. No modifications to core `thoughts` table columns (adding columns is fine, altering/dropping existing ones is not)
247
-
6.**Category-specific artifacts** — `recipes/` have code or detailed instructions, `schemas/` have SQL files, `dashboards/` have frontend code or `package.json`, `integrations/` have code files, `primitives/` have substantial READMEs (200+ words), `extensions/` have both SQL and code files
248
-
7.**PR format** — Title starts with `[recipes]`, `[schemas]`, `[dashboards]`, `[integrations]`, `[primitives]`, or `[extensions]`
257
+
6.**Category-specific artifacts** — `recipes/` have code or detailed instructions, `schemas/` have SQL files, `dashboards/` have frontend code or `package.json`, `integrations/` have code files, `skills/` have at least one plain-text skill file, `primitives/` have substantial READMEs (200+ words), `extensions/` have both SQL and code files
258
+
7.**PR format** — Title starts with `[recipes]`, `[schemas]`, `[dashboards]`, `[integrations]`, `[skills]`, `[primitives]`, or `[extensions]`
249
259
8.**No binary blobs** — No files over 1MB, no `.exe`, `.dmg`, `.zip`, `.tar.gz`
250
260
9.**README completeness** — Contribution README includes Prerequisites, step-by-step instructions, and expected outcome sections
251
261
10.**Primitive dependencies** — If a contribution declares `requires_primitives`, the primitives must exist in the repo and be linked in the README
0 commit comments