rudder-data-catalog

Name: rudder-data-catalog
Author: rudderlabs

18stars0forks

How to install rudder-data-catalog?

rudderlabs/rudder-agent-skills/rudder-data-catalog

$npx -y skills add rudderlabs/rudder-agent-skills --skill rudder-data-catalog

Installs into the current project.

Summary

Creates and manages events, properties, categories, and custom types for instrumentation schemas. Use when creating or managing events, properties, categories, or custom types for RudderStack instrumentation

Files · 1

View on GitHub

SKILL.md

1	# RudderStack Data Catalog Management
2
3	This skill teaches how to create and manage the building blocks of instrumentation: events, properties, categories, and custom types.
4
5	## Recommended Workflow
6
7	When adding or editing catalog resources, author bottom-up (dependencies first) then validate and apply. The referencing order is strict — an event can't reference a property URN until that property exists.
8
9	```dot
10	digraph data_catalog_workflow {
11	rankdir=TB;
12	"1. Custom types (reusable shapes)" [shape=box];
13	"2. Properties (vocabulary)" [shape=box];
14	"3. Categories (grouping)" [shape=box];
15	"4. Events (reference all of the above)" [shape=box];
16	"rudder-cli validate -l ./" [shape=box];
17	"Errors?" [shape=diamond];
18	"Fix references / URNs / type config" [shape=box];
19	"rudder-cli apply --dry-run -l ./" [shape=box];
20	"Diff matches intent?" [shape=diamond];
21	"rudder-cli apply -l ./" [shape=box];
22	"Done" [shape=doublecircle];
23
24	"1. Custom types (reusable shapes)" -> "2. Properties (vocabulary)";
25	"2. Properties (vocabulary)" -> "3. Categories (grouping)";
26	"3. Categories (grouping)" -> "4. Events (reference all of the above)";
27	"4. Events (reference all of the above)" -> "rudder-cli validate -l ./";
28	"rudder-cli validate -l ./" -> "Errors?";
29	"Errors?" -> "Fix references / URNs / type config" [label="yes"];
30	"Fix references / URNs / type config" -> "rudder-cli validate -l ./";
31	"Errors?" -> "rudder-cli apply --dry-run -l ./" [label="no"];
32	"rudder-cli apply --dry-run -l ./" -> "Diff matches intent?";
33	"Diff matches intent?" -> "Fix references / URNs / type config" [label="no"];
34	"Diff matches intent?" -> "rudder-cli apply -l ./" [label="yes"];
35	"rudder-cli apply -l ./" -> "Done";
36	}
37	```
38
39	Why bottom-up: properties reference custom types; events reference properties, categories, and custom types. Creating in the reverse order means every intermediate `validate` fails on missing references. For the validate → dry-run → apply details (error formats, diff reading, auth prereqs), see the `rudder-cli-workflow` skill.
40
41	## Core Concepts
42
43	\| Concept \| Purpose \| Example \|
44	\|---------\|---------\|---------\|
45	\| Events \| What happened \| "Product Viewed", "Order Completed" \|
46	\| Properties \| Attributes of events \| product_id, price, quantity \|
47	\| Categories \| Organize events \| "Ecommerce", "User Lifecycle" \|
48	\| Custom Types \| Reusable validation patterns \| ProductType, AddressType, Currency \|
49
50	## Before Creating: Check Existing Catalog
51
52	Before creating new events or properties, check what already exists to prevent duplicates and ensure consistency.
53
54	### Why Check First?
55
56	- Prevents duplicate events with different names ("Product Viewed" vs "ProductView")
57	- Ensures warehouse consistency — same data, same column names
58	- Reuses existing custom types — don't reinvent AddressType
59	- Maintains naming conventions — follow established patterns
60
61	### How to Check
62
63	Using Rudder CLI:
64	```bash
65	# List existing events
66	rudder-cli get events
67
68	# List existing properties
69	rudder-cli get properties
70
71	# List custom types
72	rudder-cli get custom-types
73	```
74
75	Using MCP:
76	```
77	Tool: list_data_catalog_events
78	Search for events matching your proposed name
79
80	Tool: list_data_catalog_properties
81	Check if property already exists
82	```
83
84	### Naming Convention Validation
85
86	Before proposing new resources, verify they follow conventions:
87
88	\| Resource \| Convention \| Example \| Anti-Example \|
89	\|----------\|------------\|---------\|--------------\|
90	\| Events \| Title Case with spaces \| `Product Viewed` \| `productViewed`, `product_viewed` \|
91	\| Properties \| snake_case \| `product_id` \| `productId`, `ProductId` \|
92	\| Categories \| kebab-case \| `user-lifecycle` \| `userLifecycle`, `user_lifecycle` \|
93	\| Custom Types \| PascalCase \| `ProductType` \| `product_type`, `productType` \|
94
95	### Check for Similar Events
96
97	If proposing "Transformation Created", search for:
98	- Existing "Transformation Created"
99	- Similar: "Transformation Added", "Create Transformation"
100	- Related: other transformation events
101
102	```bash
103	rudder-cli get events \| grep -i transform
104	```
105
106	## Directory Structure
107
108	```
109	data-catalog/
110	├── events/
111	│ ├── ecommerce.yaml # Product Viewed, Order Completed, etc.
112	│ └── user-lifecycle.yaml # Signed Up, Logged In, etc.
113	├── properties/
114	│ ├── product-properties.yaml
115	│ ├── customer-properties.yaml
116	│ └── address-properties.yaml
117	├── categories/
118	│ └── categories.yaml
119	└── custom-types/
120	├── product-type.yaml
121	└── address-type.yaml
122	```
123
124	## YAML Schemas
125
126	### Event Definition
127
128	```yaml
129	version: "rudder/v1"
130	kind: "event"
131	metadata:
132	name: "events"
133	spec:
134	name: "Product View

People who liked this also viewed

6 picks

Type

rudder-data-catalog

18stars0forks

View on GitHub

How to install rudder-data-catalog?

rudderlabs/rudder-agent-skills/rudder-data-catalog

$npx -y skills add rudderlabs/rudder-agent-skills --skill rudder-data-catalog

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# RudderStack Data Catalog Management
2
3	This skill teaches how to create and manage the building blocks of instrumentation: events, properties, categories, and custom types.
4
5	## Recommended Workflow
6
7	When adding or editing catalog resources, author bottom-up (dependencies first) then validate and apply. The referencing order is strict — an event can't reference a property URN until that property exists.
8
9	```dot
10	digraph data_catalog_workflow {
11	rankdir=TB;
12	"1. Custom types (reusable shapes)" [shape=box];
13	"2. Properties (vocabulary)" [shape=box];
14	"3. Categories (grouping)" [shape=box];
15	"4. Events (reference all of the above)" [shape=box];
16	"rudder-cli validate -l ./" [shape=box];
17	"Errors?" [shape=diamond];
18	"Fix references / URNs / type config" [shape=box];
19	"rudder-cli apply --dry-run -l ./" [shape=box];
20	"Diff matches intent?" [shape=diamond];
21	"rudder-cli apply -l ./" [shape=box];
22	"Done" [shape=doublecircle];
23
24	"1. Custom types (reusable shapes)" -> "2. Properties (vocabulary)";
25	"2. Properties (vocabulary)" -> "3. Categories (grouping)";
26	"3. Categories (grouping)" -> "4. Events (reference all of the above)";
27	"4. Events (reference all of the above)" -> "rudder-cli validate -l ./";
28	"rudder-cli validate -l ./" -> "Errors?";
29	"Errors?" -> "Fix references / URNs / type config" [label="yes"];
30	"Fix references / URNs / type config" -> "rudder-cli validate -l ./";
31	"Errors?" -> "rudder-cli apply --dry-run -l ./" [label="no"];
32	"rudder-cli apply --dry-run -l ./" -> "Diff matches intent?";
33	"Diff matches intent?" -> "Fix references / URNs / type config" [label="no"];
34	"Diff matches intent?" -> "rudder-cli apply -l ./" [label="yes"];
35	"rudder-cli apply -l ./" -> "Done";
36	}
37	```
38
39	Why bottom-up: properties reference custom types; events reference properties, categories, and custom types. Creating in the reverse order means every intermediate `validate` fails on missing references. For the validate → dry-run → apply details (error formats, diff reading, auth prereqs), see the `rudder-cli-workflow` skill.
40
41	## Core Concepts
42
43	\| Concept \| Purpose \| Example \|
44	\|---------\|---------\|---------\|
45	\| Events \| What happened \| "Product Viewed", "Order Completed" \|
46	\| Properties \| Attributes of events \| product_id, price, quantity \|
47	\| Categories \| Organize events \| "Ecommerce", "User Lifecycle" \|
48	\| Custom Types \| Reusable validation patterns \| ProductType, AddressType, Currency \|
49
50	## Before Creating: Check Existing Catalog
51
52	Before creating new events or properties, check what already exists to prevent duplicates and ensure consistency.
53
54	### Why Check First?
55
56	- Prevents duplicate events with different names ("Product Viewed" vs "ProductView")
57	- Ensures warehouse consistency — same data, same column names
58	- Reuses existing custom types — don't reinvent AddressType
59	- Maintains naming conventions — follow established patterns
60
61	### How to Check
62
63	Using Rudder CLI:
64	```bash
65	# List existing events
66	rudder-cli get events
67
68	# List existing properties
69	rudder-cli get properties
70
71	# List custom types
72	rudder-cli get custom-types
73	```
74
75	Using MCP:
76	```
77	Tool: list_data_catalog_events
78	Search for events matching your proposed name
79
80	Tool: list_data_catalog_properties
81	Check if property already exists
82	```
83
84	### Naming Convention Validation
85
86	Before proposing new resources, verify they follow conventions:
87
88	\| Resource \| Convention \| Example \| Anti-Example \|
89	\|----------\|------------\|---------\|--------------\|
90	\| Events \| Title Case with spaces \| `Product Viewed` \| `productViewed`, `product_viewed` \|
91	\| Properties \| snake_case \| `product_id` \| `productId`, `ProductId` \|
92	\| Categories \| kebab-case \| `user-lifecycle` \| `userLifecycle`, `user_lifecycle` \|
93	\| Custom Types \| PascalCase \| `ProductType` \| `product_type`, `productType` \|
94
95	### Check for Similar Events
96
97	If proposing "Transformation Created", search for:
98	- Existing "Transformation Created"
99	- Similar: "Transformation Added", "Create Transformation"
100	- Related: other transformation events
101
102	```bash
103	rudder-cli get events \| grep -i transform
104	```
105
106	## Directory Structure
107
108	```
109	data-catalog/
110	├── events/
111	│ ├── ecommerce.yaml # Product Viewed, Order Completed, etc.
112	│ └── user-lifecycle.yaml # Signed Up, Logged In, etc.
113	├── properties/
114	│ ├── product-properties.yaml
115	│ ├── customer-properties.yaml
116	│ └── address-properties.yaml
117	├── categories/
118	│ └── categories.yaml
119	└── custom-types/
120	├── product-type.yaml
121	└── address-type.yaml
122	```
123
124	## YAML Schemas
125
126	### Event Definition
127
128	```yaml
129	version: "rudder/v1"
130	kind: "event"
131	metadata:
132	name: "events"
133	spec:
134	name: "Product View

People who liked this also viewed

6 picks

Type