Backstage AI catalog
Model AI context as governed catalog entities while keeping skill and rule content in its source repository.
When to invoke
- "Catalog our AI skills and governance rules in Backstage."
- "Register an MCP server as an API entity."
- "Add the AiResource kind to Backstage."
- "Model ownership and dependencies between AI resources."
Procedure
- Confirm the target Backstage version and catalog backend mode.
- Verify the current AI catalog documentation and package version.
- Install
@backstage/plugin-catalog-backend-module-ai-modelinpackages/backendand register the module through the backend system. - Model a skill or rule as
kind: AiResourcewith lifecycle, owner, system, and type-specific fields. - Point
backstage.io/source-locationat the source skill or rule; do not copy its complete content into the entity. - Model an MCP server as
kind: API,spec.type: mcp-server, with one or more explicitremotes. - Validate entity schemas, references, ownership, lifecycle, URLs, and catalog ingestion.
- Protect internal or non-production MCP endpoints with repository policy and network controls.
Model boundaries
AiResourcetypeskillmay declare disciplines, categories, agents, anddependsOn.AiResourcetyperulerequires a category and rationale.mcp-serveris an API subtype and usesremotes, not an embedded OpenAPI definition.- Source content remains external and addressable through source-location annotations.
Output template
## Backstage AI catalog result
| Entity | Type | Owner | Source or remote | Validation |
| --- | --- | --- | --- | --- |
### Module
- Package:
- Backend registration:
Quality gate
- The AI catalog module and target version are verified.
- Every AI resource has stable identity, lifecycle, owner, and source location.
- Skill dependencies and rule rationales are explicit.
- MCP remotes use valid transport types and URLs.
- Catalog ingestion validates the registered model.
- Sensitive internal endpoints and credentials are not exposed.