@open-mcp/backstage-catalog

Using the remote server

To use the hosted Streamable HTTP server, add the following to your client config:

{
  "mcpServers": {
    "backstage-catalog": {
      "transport": "streamableHttp",
      "url": "https://mcp.open-mcp.org/api/server/backstage-catalog@latest/mcp"
    }
  }
}

Forwarding variables

You can forward "environment" variables to the remote server by including them in the request headers or URL query string (headers take precedence). Just prefix the variable name with FORWARD_VAR_ like so:

https://mcp.open-mcp.org/api/server/backstage-catalog@latest/mcp?FORWARD_VAR_OPEN_MCP_BASE_URL=https%3A%2F%2Fapi.example.com

Installing locally

If you want to run the server locally on your own machine instead of using the remote server, first set the environment variables as shell variables:

API_KEY='...'

Then use the OpenMCP config CLI to add the server to your MCP client:

Claude desktop

npx @open-mcp/config add backstage-catalog \
  ~/Library/Application\ Support/Claude/claude_desktop_config.json \
  --API_KEY=$API_KEY

Cursor

Run this from the root of your project directory or, to add to all cursor projects, run it from your home directory ~.

npx @open-mcp/config add backstage-catalog \
  .cursor/mcp.json \
  --API_KEY=$API_KEY

Other

npx @open-mcp/config add backstage-catalog \
  /path/to/client/config.json \
  --API_KEY=$API_KEY

Manually

If you don't want to use the helper above, add the following to your MCP client config manually:

{
  "mcpServers": {
    "backstage-catalog": {
      "command": "npx",
      "args": ["-y", "@open-mcp/backstage-catalog"],
      "env": {"API_KEY":"..."}
    }
  }
}

Environment variables

• OPEN_MCP_BASE_URL - overwrites the base URL of every tool's underlying API request
• API_KEY - gets sent to the API provider

Tools

expandSchema

Expand the input schema for a tool before calling the tool

Input schema

• toolName (string)
• jsonPointers (array)

refreshentity

Environment variables

• API_KEY

Input schema

• authorizationToken (string)
• entityRef (string)

getentities

Environment variables

• API_KEY

Input schema

• fields (array)
• limit (integer)
• filter (array)
• offset (integer)
• after (string)
• order (array)

getentitybyuid

Environment variables

• API_KEY

Input schema

• uid (string)

deleteentitybyuid

Environment variables

• API_KEY

Input schema

• uid (string)

getentitybyname

Environment variables

• API_KEY

Input schema

• kind (string)
• namespace (string)
• name (string)

getentityancestrybyname

Environment variables

• API_KEY

Input schema

• kind (string)
• namespace (string)
• name (string)

getentitiesbyrefs

Environment variables

• API_KEY

Input schema

• filter (array)
• entityRefs (array)
• fields (array)

getentitiesbyquery

Environment variables

• API_KEY

Input schema

• fields (array)
• limit (integer)
• offset (integer)
• orderField (array)
• cursor (string)
• filter (array)
• fullTextFilterTerm (string)
• fullTextFilterFields (array)

getentityfacets

Environment variables

• API_KEY

Input schema

• facet (array)
• filter (array)

createlocation

Environment variables

• API_KEY

Input schema

• dryRun (string)
• target (string)
• type (string)

getlocations

Environment variables

• API_KEY

Input schema

No input parameters

getlocation

Environment variables

• API_KEY

Input schema

• id (string)

deletelocation

Environment variables

• API_KEY

Input schema

• id (string)

getlocationbyentity

Environment variables

• API_KEY

Input schema

• kind (string)
• namespace (string)
• name (string)

analyzelocation

Environment variables

• API_KEY

Input schema

• catalogFileName (string)
• location (object)

validateentity

Environment variables

• API_KEY

Input schema

• location (string)
• entity (object)