@contentrain/skills 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +3 -2
- package/skills/contentrain/SKILL.md +1 -1
- package/skills/contentrain/references/architecture.md +2 -0
- package/skills/contentrain/references/content-formats.md +1 -0
- package/skills/contentrain/references/mcp-tools.md +43 -0
- package/skills/contentrain/references/model-kinds.md +5 -1
- package/skills/contentrain/references/schema-types.md +2 -0
- package/skills/contentrain-content/SKILL.md +1 -1
- package/skills/contentrain-model/SKILL.md +25 -0
- package/skills/contentrain-normalize/references/extraction.md +1 -0
- package/workflows/contentrain-content.md +1 -0
- package/workflows/contentrain-model.md +25 -0
- package/workflows/contentrain-normalize.md +1 -0
package/README.md
CHANGED
|
@@ -127,7 +127,7 @@ This reduces always-loaded context from thousands of lines to just the essential
|
|
|
127
127
|
|
|
128
128
|
`@contentrain/skills` is kept in lockstep with the MCP tool registry via cross-package parity tests (`tests/mcp-parity.test.ts`):
|
|
129
129
|
|
|
130
|
-
- `skills/contentrain/references/mcp-tools.md` must have an `### <tool>` heading for every tool in the MCP `TOOL_NAMES` registry (currently
|
|
130
|
+
- `skills/contentrain/references/mcp-tools.md` must have an `### <tool>` heading for every tool in the MCP `TOOL_NAMES` registry (currently 26: 21 core + 5 media).
|
|
131
131
|
- Key skills (normalize, translate) must not reference legacy `contentrain/{operation}/...` branch prefixes — MCP now emits `cr/*`.
|
|
132
132
|
|
|
133
133
|
When MCP's surface changes, these tests fail until the skill docs catch up.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentrain/skills",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "AI agent skills for Contentrain — workflow procedures, framework integration guides",
|
|
6
6
|
"type": "module",
|
|
@@ -61,7 +61,8 @@
|
|
|
61
61
|
"tsdown": "^0.21.0",
|
|
62
62
|
"typescript": "^5.7.0",
|
|
63
63
|
"vitest": "^3.0.0",
|
|
64
|
-
"@contentrain/mcp": "
|
|
64
|
+
"@contentrain/mcp": "3.0.0",
|
|
65
|
+
"@contentrain/rules": "0.7.0"
|
|
65
66
|
},
|
|
66
67
|
"scripts": {
|
|
67
68
|
"build": "tsdown src/index.ts --format esm,cjs --dts",
|
|
@@ -16,7 +16,7 @@ Contentrain consists of 6 packages that work together:
|
|
|
16
16
|
|
|
17
17
|
| Package | Role | How agent uses it |
|
|
18
18
|
|---|---|---|
|
|
19
|
-
| @contentrain/mcp |
|
|
19
|
+
| @contentrain/mcp | 21 MCP tools (scan, apply, validate, merge, doctor...) | MCP tool calls |
|
|
20
20
|
| contentrain (CLI) | init, serve, generate, doctor, diff, status | Shell commands |
|
|
21
21
|
| @contentrain/types | Shared TypeScript contracts | Type safety |
|
|
22
22
|
| @contentrain/query | Generated SDK client (Prisma-pattern) | `import from '#contentrain'` |
|
|
@@ -81,6 +81,7 @@ Model definitions live at `.contentrain/models/{model-id}.json`. One file per mo
|
|
|
81
81
|
"kind": "document",
|
|
82
82
|
"domain": "blog",
|
|
83
83
|
"i18n": true,
|
|
84
|
+
"title_field": "title",
|
|
84
85
|
"description": "Blog articles with markdown body",
|
|
85
86
|
"fields": {
|
|
86
87
|
"title": { "type": "string", "required": true, "max": 120 },
|
|
@@ -100,6 +101,7 @@ Model definitions live at `.contentrain/models/{model-id}.json`. One file per mo
|
|
|
100
101
|
| `kind` | string | Yes | `singleton`, `collection`, `document`, `dictionary` |
|
|
101
102
|
| `domain` | string | Yes | Organizational group (maps to content subdirectory) |
|
|
102
103
|
| `i18n` | boolean | Yes | Whether model supports multiple locales |
|
|
104
|
+
| `title_field` | string | Yes | Field shown as an entry's title. Must name a field on this model whose type can render as text; dictionaries use `"key"` |
|
|
103
105
|
| `description` | string | No | Model description for docs and agent context |
|
|
104
106
|
| `fields` | object | Yes (except dictionary) | Field definitions. Dictionary has NO fields |
|
|
105
107
|
| `content_path` | string | No | Framework-relative path. When set, content writes here instead of `.contentrain/content/` |
|
|
@@ -183,6 +183,7 @@ Several fields are managed by the platform. Agents MUST NOT set or modify them.
|
|
|
183
183
|
| `status` | `.contentrain/meta/` | Platform workflow engine |
|
|
184
184
|
| `source` | `.contentrain/meta/` | Set by MCP: `"agent"`, `"human"`, or `"import"` |
|
|
185
185
|
| `updated_by` | `.contentrain/meta/` | Set by MCP: agent name or user email |
|
|
186
|
+
| `updated_at` | `.contentrain/meta/` | Set by MCP on every write, ISO 8601 UTC. Absent on entries written before the field existed — absent means unknown, never backfilled |
|
|
186
187
|
| `approved_by` | `.contentrain/meta/` | Set by Studio on review approval |
|
|
187
188
|
|
|
188
189
|
**Rule:** When creating content via `contentrain_content_save`, provide only the content fields defined in the model. Do not include `id`, `createdAt`, `updatedAt`, `status`, or any metadata fields.
|
|
@@ -88,6 +88,7 @@ Create or update a model definition (upsert).
|
|
|
88
88
|
| `kind` | string | Yes | `singleton`, `collection`, `document`, `dictionary` |
|
|
89
89
|
| `domain` | string | Yes | Organizational group |
|
|
90
90
|
| `i18n` | boolean | Yes | Whether model supports localization |
|
|
91
|
+
| `title_field` | string | Yes | Field shown as an entry's title. Must name a field on this model typed `string`, `text`, `slug`, `email`, `url`, `code`, `markdown` or `richtext`. Dictionaries have no fields — use `"key"` |
|
|
91
92
|
| `fields` | object | No | Field definitions (not for dictionary) |
|
|
92
93
|
| `description` | string | No | Model description |
|
|
93
94
|
| `content_path` | string | No | Framework-relative path for content files |
|
|
@@ -95,6 +96,8 @@ Create or update a model definition (upsert).
|
|
|
95
96
|
|
|
96
97
|
Notes:
|
|
97
98
|
- Upserts by model ID: existing model is updated, new model is created
|
|
99
|
+
- `title_field` is required on create AND must stay correct when you rename or drop a field
|
|
100
|
+
- Pick what a reader uses to tell entries apart — the headline, the name, the question. Not the slug, not the icon, not a relation ID
|
|
98
101
|
- `locale_strategy: "none"` requires `i18n: false`
|
|
99
102
|
- `content_path` overrides default `.contentrain/content/` location
|
|
100
103
|
|
|
@@ -161,6 +164,46 @@ Delete a content entry.
|
|
|
161
164
|
> mapped onto `data.json` + the default-locale meta. Omit `locale`; use
|
|
162
165
|
> `contentrain_validate` `fix: true` to clean up stray per-locale meta.
|
|
163
166
|
|
|
167
|
+
### contentrain_vocabulary_save
|
|
168
|
+
|
|
169
|
+
Add or update canonical vocabulary terms. Merges — a term you omit is untouched.
|
|
170
|
+
|
|
171
|
+
| Parameter | Type | Required | Description |
|
|
172
|
+
|-----------|------|----------|-------------|
|
|
173
|
+
| `terms` | object | Yes | `{ "term-slug": { "en": "…", "tr": "…" } }` |
|
|
174
|
+
|
|
175
|
+
The **outer** key is the term (kebab-case, locale-independent); the **inner**
|
|
176
|
+
key is a locale code. Grouping by locale at the top level is the common
|
|
177
|
+
mistake and produces a vocabulary that matches nothing — the tool rejects it.
|
|
178
|
+
|
|
179
|
+
```json
|
|
180
|
+
{
|
|
181
|
+
"terms": {
|
|
182
|
+
"sign-in": { "en": "Sign in", "tr": "Giriş yap" },
|
|
183
|
+
"add-to-cart": { "en": "Add to cart", "tr": "Sepete ekle" }
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Notes:
|
|
189
|
+
- This is the only supported way to write `.contentrain/vocabulary.json` — do not edit it by hand
|
|
190
|
+
- Replacing an existing translation is allowed and reported in `advisories`
|
|
191
|
+
- Two terms sharing a translation is reported too; that is what a vocabulary exists to prevent
|
|
192
|
+
|
|
193
|
+
### contentrain_vocabulary_delete
|
|
194
|
+
|
|
195
|
+
Remove canonical terms by slug. Content already using a term is not touched —
|
|
196
|
+
the vocabulary only advises.
|
|
197
|
+
|
|
198
|
+
| Parameter | Type | Required | Description |
|
|
199
|
+
|-----------|------|----------|-------------|
|
|
200
|
+
| `terms` | string[] | Yes | Term slugs to remove |
|
|
201
|
+
| `confirm` | boolean | Yes | Must be `true` |
|
|
202
|
+
|
|
203
|
+
A slug that is not in the vocabulary is reported in `missing`, not an error,
|
|
204
|
+
and a call that matches nothing returns `status: "no-op"` without creating a
|
|
205
|
+
branch.
|
|
206
|
+
|
|
164
207
|
### contentrain_content_list
|
|
165
208
|
|
|
166
209
|
List content entries for a model (read-only).
|
|
@@ -28,6 +28,7 @@ Contentrain has four model kinds, each with distinct storage format, ID manageme
|
|
|
28
28
|
"kind": "singleton",
|
|
29
29
|
"domain": "marketing",
|
|
30
30
|
"i18n": true,
|
|
31
|
+
"title_field": "title",
|
|
31
32
|
"fields": {
|
|
32
33
|
"title": { "type": "string", "required": true, "max": 80 },
|
|
33
34
|
"subtitle": { "type": "text", "max": 200 },
|
|
@@ -73,6 +74,7 @@ Contentrain has four model kinds, each with distinct storage format, ID manageme
|
|
|
73
74
|
"kind": "collection",
|
|
74
75
|
"domain": "marketing",
|
|
75
76
|
"i18n": true,
|
|
77
|
+
"title_field": "name",
|
|
76
78
|
"fields": {
|
|
77
79
|
"name": { "type": "string", "required": true },
|
|
78
80
|
"role": { "type": "string", "required": true },
|
|
@@ -148,6 +150,7 @@ MCP tools return collections as arrays with `id` injected:
|
|
|
148
150
|
"kind": "document",
|
|
149
151
|
"domain": "blog",
|
|
150
152
|
"i18n": true,
|
|
153
|
+
"title_field": "title",
|
|
151
154
|
"fields": {
|
|
152
155
|
"title": { "type": "string", "required": true, "max": 120 },
|
|
153
156
|
"slug": { "type": "slug", "required": true, "unique": true },
|
|
@@ -204,7 +207,8 @@ Your markdown body content here...
|
|
|
204
207
|
"name": "Error Messages",
|
|
205
208
|
"kind": "dictionary",
|
|
206
209
|
"domain": "system",
|
|
207
|
-
"i18n": true
|
|
210
|
+
"i18n": true,
|
|
211
|
+
"title_field": "key"
|
|
208
212
|
}
|
|
209
213
|
```
|
|
210
214
|
|
|
@@ -165,6 +165,8 @@ In v1, media fields store URL/path strings only. Upload and processing are out o
|
|
|
165
165
|
| `accept` | `image`, `video`, `file` | Allowed MIME types: `"image/png,image/jpeg"` |
|
|
166
166
|
| `maxSize` | `image`, `video`, `file` | Maximum file size in bytes |
|
|
167
167
|
| `description` | ALL | Human-readable hint (shown in Studio UI tooltip, used as agent context) |
|
|
168
|
+
| `label` | ALL | Editor label: a string, or an object keyed by locale (`{ "en": "Body", "tr": "Gövde" }`). Absent shows the raw field name |
|
|
169
|
+
| `order` | ALL | Display position, ascending. Absent sorts last, alphabetically. Fractional values allowed |
|
|
168
170
|
|
|
169
171
|
## Omission Rules
|
|
170
172
|
|
|
@@ -63,7 +63,7 @@ If the user's request does not match an existing model, offer to create one firs
|
|
|
63
63
|
|
|
64
64
|
- Check `.contentrain/vocabulary.json` for canonical terms. All content must use these terms consistently across locales. Do not use alternative spellings or synonyms for vocabulary-defined terms.
|
|
65
65
|
- Check `.contentrain/context.json` for tone conventions (professional, casual, technical).
|
|
66
|
-
- **For dictionaries:** Before creating any new key, call `contentrain_content_list` on the target model and scan existing values. If the value you intend to write already exists under a different key, REUSE the existing key instead of creating a new one. MCP will also warn you via `advisories` in the save response if duplicates are detected.
|
|
66
|
+
- **For dictionaries:** Before creating any new key, call `contentrain_content_list` on the target model and scan existing values. If the value you intend to write already exists under a different key, REUSE the existing key instead of creating a new one. MCP will also warn you via `advisories` in the save response if duplicates are detected. Replacing an existing key's value is allowed — the response reports what was replaced, so read the advisories rather than assuming a save was purely additive.
|
|
67
67
|
|
|
68
68
|
### 5. Generate Content
|
|
69
69
|
|
|
@@ -95,6 +95,7 @@ Before writing, show:
|
|
|
95
95
|
- domain
|
|
96
96
|
- `i18n` behavior
|
|
97
97
|
- field list with types
|
|
98
|
+
- `title_field` — which field titles an entry, and why that one
|
|
98
99
|
- relation targets
|
|
99
100
|
- any custom `content_path` / `locale_strategy`
|
|
100
101
|
|
|
@@ -113,6 +114,7 @@ Example:
|
|
|
113
114
|
"kind": "singleton",
|
|
114
115
|
"domain": "marketing",
|
|
115
116
|
"i18n": true,
|
|
117
|
+
"title_field": "title",
|
|
116
118
|
"fields": {
|
|
117
119
|
"title": { "type": "string", "required": true },
|
|
118
120
|
"subtitle": { "type": "text" },
|
|
@@ -122,6 +124,29 @@ Example:
|
|
|
122
124
|
}
|
|
123
125
|
```
|
|
124
126
|
|
|
127
|
+
`title_field` is required. It names the field shown as an entry's title in
|
|
128
|
+
listings, pickers and relation references, and must be a field on this model
|
|
129
|
+
typed `string`, `text`, `slug`, `email`, `url`, `code`, `markdown` or
|
|
130
|
+
`richtext`. Dictionary models have no fields, so they use the reserved value
|
|
131
|
+
`"key"` — the entry key is the title.
|
|
132
|
+
|
|
133
|
+
Choose what a reader uses to tell one entry from another: the headline, the
|
|
134
|
+
name, the question. Not the slug, not the icon, not a relation ID. Consumers
|
|
135
|
+
that had to infer this picked the icon over the headline, which is why the
|
|
136
|
+
property exists.
|
|
137
|
+
|
|
138
|
+
**When updating an existing model**, re-check `title_field` in the same call:
|
|
139
|
+
renaming or removing the field it points at makes the model invalid.
|
|
140
|
+
|
|
141
|
+
Give every field a `label` and an `order`. Fields are stored alphabetically, so
|
|
142
|
+
without `order` an editor lists them alphabetically — on a sixteen-field article
|
|
143
|
+
model that puts `author` first and `title` fifteenth. Without `label` it shows
|
|
144
|
+
the raw key: `body_public`, `is_category_hero`.
|
|
145
|
+
|
|
146
|
+
Number `order` in tens (10, 20, 30) so a field can be inserted later without
|
|
147
|
+
renumbering. Use a per-locale `label` (`{ "en": "…", "tr": "…" }`) on a
|
|
148
|
+
multilingual project; a plain string is one label for every locale.
|
|
149
|
+
|
|
125
150
|
### 8. Validate Downstream Impact
|
|
126
151
|
|
|
127
152
|
After changing a model:
|
|
@@ -67,6 +67,7 @@ After evaluation, write the plan as `.contentrain/normalize-plan.json`:
|
|
|
67
67
|
"kind": "singleton",
|
|
68
68
|
"domain": "marketing",
|
|
69
69
|
"i18n": true,
|
|
70
|
+
"title_field": "title",
|
|
70
71
|
"fields": {
|
|
71
72
|
"title": { "type": "string", "required": true },
|
|
72
73
|
"subtitle": { "type": "string" }
|
|
@@ -100,6 +100,7 @@ contentrain_content_save({
|
|
|
100
100
|
- **collection:** `{ "id": "optional-id", "locale": "en", "data": { "name": "John", "role": "CEO" } }` -- omit `id` to auto-generate, provide `id` to update.
|
|
101
101
|
- **document:** `{ "slug": "getting-started", "locale": "en", "data": { "title": "Getting Started", "body": "# Welcome\n..." } }` -- `slug` is required, use `"body"` key for markdown content.
|
|
102
102
|
- **dictionary:** `{ "locale": "en", "data": { "auth.login": "Log In", "auth.logout": "Log Out" } }` -- flat key-value pairs, no `id` or `slug`.
|
|
103
|
+
Saves merge: keys you omit are kept, and replacing an existing key's value is allowed. The response reports what was replaced, so read `advisories` rather than assuming a save was purely additive.
|
|
103
104
|
|
|
104
105
|
**Critical rules:**
|
|
105
106
|
- NEVER include system fields (`status`, `source`, `updated_by`, `approved_by`) in `data`. These are managed in meta files, not content. Temporal data (created/updated timestamps) comes from git history.
|
|
@@ -87,6 +87,7 @@ Before writing, show:
|
|
|
87
87
|
- domain
|
|
88
88
|
- `i18n` behavior
|
|
89
89
|
- field list with types
|
|
90
|
+
- `title_field` — which field titles an entry, and why that one
|
|
90
91
|
- relation targets
|
|
91
92
|
- any custom `content_path` / `locale_strategy`
|
|
92
93
|
|
|
@@ -105,6 +106,7 @@ Example:
|
|
|
105
106
|
"kind": "singleton",
|
|
106
107
|
"domain": "marketing",
|
|
107
108
|
"i18n": true,
|
|
109
|
+
"title_field": "title",
|
|
108
110
|
"fields": {
|
|
109
111
|
"title": { "type": "string", "required": true },
|
|
110
112
|
"subtitle": { "type": "text" },
|
|
@@ -114,6 +116,29 @@ Example:
|
|
|
114
116
|
}
|
|
115
117
|
```
|
|
116
118
|
|
|
119
|
+
`title_field` is required. It names the field shown as an entry's title in
|
|
120
|
+
listings, pickers and relation references, and must be a field on this model
|
|
121
|
+
typed `string`, `text`, `slug`, `email`, `url`, `code`, `markdown` or
|
|
122
|
+
`richtext`. Dictionary models have no fields, so they use the reserved value
|
|
123
|
+
`"key"` — the entry key is the title.
|
|
124
|
+
|
|
125
|
+
Choose what a reader uses to tell one entry from another: the headline, the
|
|
126
|
+
name, the question. Not the slug, not the icon, not a relation ID. Consumers
|
|
127
|
+
that had to infer this picked the icon over the headline, which is why the
|
|
128
|
+
property exists.
|
|
129
|
+
|
|
130
|
+
**When updating an existing model**, re-check `title_field` in the same call:
|
|
131
|
+
renaming or removing the field it points at makes the model invalid.
|
|
132
|
+
|
|
133
|
+
Give every field a `label` and an `order`. Fields are stored alphabetically, so
|
|
134
|
+
without `order` an editor lists them alphabetically — on a sixteen-field article
|
|
135
|
+
model that puts `author` first and `title` fifteenth. Without `label` it shows
|
|
136
|
+
the raw key: `body_public`, `is_category_hero`.
|
|
137
|
+
|
|
138
|
+
Number `order` in tens (10, 20, 30) so a field can be inserted later without
|
|
139
|
+
renumbering. Use a per-locale `label` (`{ "en": "…", "tr": "…" }`) on a
|
|
140
|
+
multilingual project; a plain string is one label for every locale.
|
|
141
|
+
|
|
117
142
|
### 8. Validate Downstream Impact
|
|
118
143
|
|
|
119
144
|
After changing a model:
|
|
@@ -93,6 +93,7 @@ After evaluating candidates, write the plan as `.contentrain/normalize-plan.json
|
|
|
93
93
|
"kind": "singleton",
|
|
94
94
|
"domain": "marketing",
|
|
95
95
|
"i18n": true,
|
|
96
|
+
"title_field": "title",
|
|
96
97
|
"fields": { "title": { "type": "string", "required": true }, "subtitle": { "type": "string" } }
|
|
97
98
|
}
|
|
98
99
|
],
|