diff --git a/plugins/catalog-backend-module-ai-resource-entity-model/README.md b/plugins/catalog-backend-module-ai-resource-entity-model/README.md new file mode 100644 index 0000000000..c30fb20941 --- /dev/null +++ b/plugins/catalog-backend-module-ai-resource-entity-model/README.md @@ -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`.