Backstage icon

Backstage

Query Backstage software catalog and TechDocs via MCP

Catalog → Get Relationships

AI-generated

Summary

Traverse Backstage catalog relationships from a root entity reference and return the matches up to the selected depth.

Inputs

  • Entity Ref (required) — Root entity reference to traverse from, such as component:default/my-service.
  • Direction — Relationship traversal direction: outbound (default), inbound, or both.
  • Relation Type — Optional relation type filter, such as dependsOn or consumesApi.
  • Depth — Maximum traversal depth; defaults to 3 and accepts values from 1 to 5.

Output shape

A list of items containing the relationship traversal result.

The supplied source excerpt does not expose the operation's execution body, so the exact response fields and whether results are split across items cannot be determined.

Links

Discussion