docs: add README for ai-resource-entity-model module

Signed-off-by: benjdlambert <ben@blam.sh>
2026-05-15 14:24:32 +02:00
parent 37267be659
commit c41b6d09f7
1 changed files with 42 additions and 0 deletions
@@ -0,0 +1,42 @@
+# @backstage/plugin-catalog-backend-module-ai-resource-entity-model
+
+Adds support for the `AIResource` entity kind to the catalog backend plugin. AI resources represent contextual information consumed by AI coding tools, such as skills and rules.
+
+## Installation
+
+Add the module to your backend:
+
+```ts
+backend.add(
+  import('@backstage/plugin-catalog-backend-module-ai-resource-entity-model'),
+);
+```
+
+## Entity shape
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: AIResource
+metadata:
+  name: frontend-design
+  description: Skill for creating production-grade frontend interfaces
+spec:
+  type: skill
+  lifecycle: production
+  owner: ai-platform-team
+  system: ai-tooling
+  disciplines:
+    - web
+  categories:
+    - framework
+  agents:
+    - claude-code
+  dependsOn:
+    - airesource:default/base-coding-standards
+```
+
+The `type` field determines which spec fields are available. Currently supported types:
+
+- **`skill`** — reusable contextual knowledge for AI coding tools. Supports additional fields: `disciplines`, `categories`, `agents`, `dependsOn`.
+
+Any other `type` value is accepted with the base spec fields: `type`, `lifecycle`, `owner`, and optionally `system`.