skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
vinzscam/backstage-skills49 installs

using-backstage-backend-system

Use when defining or authoring a Backstage backend plugin or module. DEFAULT is createBackendPlugin when you own the HTTP routes and database; use createBackendModule only when extending another plugin (e.g. adding a processor to the catalog plugin). Triggers on imports from @backstage/backend-plugin-api or when writing src/plugin.ts, src/module.ts, src/index.ts in a backend package.

How do I install this agent skill?

npx skills add https://github.com/vinzscam/backstage-skills --skill using-backstage-backend-system
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    The skill provides standard patterns and templates for developing Backstage backend plugins and modules using the official @backstage/backend-plugin-api. No security risks were identified.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

What does this agent skill do?

Backstage Backend System Patterns

When to use this skill

  • Defining a new backend plugin (src/plugin.ts)
  • Defining a backend module (src/module.ts) that extends another plugin
  • Choosing between a full plugin vs a module
  • Exposing extension points so other modules can extend your plugin

Defaults

  • Your code owns HTTP routes or a database → createBackendPlugin. The plugin gets its own pluginId, its own scoped services (logger, database, httpRouter), and mounts routes at /api/<pluginId>/.
  • Your code extends another plugin (e.g. adding a catalog processor, a scaffolder action) → createBackendModule. The module targets an existing plugin's pluginId and registers against that plugin's extension point.
  • Extension points are only needed when you're building a plugin that other teams will extend via modules. Most plugins don't need them.

Choose the right pattern

Building...PatternReference
A standalone backend service (use this by default)createBackendPlugin({ pluginId, register })references/plugin-definition.md
A module that extends another plugincreateBackendModule({ pluginId, moduleId, register })references/modules.md
An extension point so other modules can extend yourscreateExtensionPoint<T>({ id })references/extension-points.md

Two invocation modes

  • Standalone: editing an existing backend plugin/module.
  • Post-scaffold (called by creating-backstage-plugin for backend-plugin, backend-plugin-module, catalog-provider-module, scaffolder-backend-module): wire up the canonical structure (src/plugin.ts or src/module.ts, src/index.ts re-export).

Common gotchas

  • All wiring imports come from @backstage/backend-plugin-api, not @backstage/core-plugin-api (which is frontend-only).
  • The register(env) callback receives an environment object with env.registerInit({ deps, async init }) and env.registerExtensionPoint(point, impl). deps is a map of service refs the init function needs; init receives the resolved instances.
  • registerInit may be called only once per plugin/module. registerExtensionPoint must be called before registerInit.
  • Plugin-scoped vs root-scoped services: most refs (logger, httpRouter, database, scheduler, auth, httpAuth, userInfo, cache, discovery, urlReader, lifecycle, permissions) are plugin-scoped — each plugin gets its own instance with plugin-aware behavior (e.g. logger pre-tagged with pluginId, database giving a per-plugin schema). Six refs (rootConfig, rootLogger, rootLifecycle, rootHealth, rootHttpRouter, rootInstanceMetadata) are root-scoped — single shared instance. Both can be depended on from a plugin's register block; the distinction matters for behavior, not for injection syntax.
  • A plugin's pluginId and a module's moduleId must match the pattern [a-z][a-z0-9-]* (letters, digits, dashes; starts with a letter).
  • Modules depend on the extension points exported by the target plugin's library package (e.g. @backstage/plugin-catalog-node), not on the plugin's main package.

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/vinzscam/backstage-skills/using-backstage-backend-system">View using-backstage-backend-system on skillZs</a>