Serveur MCP Backstage
Commit 13 nov. 2026Expose l'API du Backstage Software Catalog sous forme d'outils pour permettre aux LLM d'effectuer de la découverte d'entités, des opérations sur le catalogue et de la validation.
Aussi connu sous Coderrob/backstage-mcp-server
- Étoiles
- 3
- Outils
- —
- Téléchargements, 30 jours
- —
- Dernière version
- —
- Dernier commit
- 13 nov. 2026
- Licence
- GPL-3.0
Qu'est-ce que Backstage MCP ?
Backstage est un serveur MCP. Expose l'API du Backstage Software Catalog sous forme d'outils pour permettre aux LLM d'effectuer de la découverte d'entités, des opérations sur le catalogue et de la validation.
Résumé généré à partir du README du projet
À propos du MCP server Backstage
La gestion des catalogues de logiciels via des agents IA est rendue possible par ce serveur, qui connecte les LLM à l'API Backstage Software Catalog. Il fournit 32 outils spécialisés pour découvrir des entités, gérer des localisations et valider des descripteurs via une connexion stdio. Les développeurs peuvent l'utiliser pour interroger l'ascendance des entités, les facettes et les localisations sources, ou effectuer des mutations comme l'ajout de localisations et l'actualisation d'entités.
Pour configurer le serveur, vous avez besoin de Node.js 24.15 ou plus récent et d'un backend Backstage accessible. L'authentification est gérée par un jeton bearer fourni via la variable d'environnement BACKSTAGE_TOKEN ou par un BACKSTAGE_TOKEN_FILE pour la rotation des identifiants. Le serveur utilise le CatalogClient officiel de Backstage pour garantir une intégration de niveau production. Il inclut des fonctionnalités de sécurité intégrées telles que des limites de débit par principal, des timeouts et des annotations permettant de distinguer les outils en lecture seule, de mutation et de destruction comme remove_entity_by_uid.
Ce que vous pouvez faire avec
- 1Découverte de composants logicielsDemandez à l'IA de trouver tous les composants et API au sein d'un namespace spécifique.
Extrait du README du projet. Chaque cas d'utilisation est vérifié par rapport à une citation du document.
Configuration
BACKSTAGE_BASE_URLBACKSTAGE_TOKENBACKSTAGE_TOKEN_FILE
| Nom | Description | Type |
|---|---|---|
| BACKSTAGE_BASE_URL | — | |
| BACKSTAGE_TOKEN | — | |
| BACKSTAGE_TOKEN_FILE | — |
Vérifications automatisées
Exécuté le 14 nov. 2026Rapport complet →Pas encore vérifié. Un serveur nécessite un score de 80, aucune faille sérieuse et suffisamment de données pour que nous puissions effectuer les vérifications. Fonctionnement des vérifications · Ce qu'il faut corriger pour gagner des points
- Dépôt source lié et accessiblecoderrob/backstage-mcp-server is public and reachablegithub.com/coderrob/backstage-mcp-server ↗Réussi
- Le nom du package correspond au dépôt sourceNon vérifié
- Provenance du build (attestation Sigstore)Non vérifié
- Licence open source (OSI)GPL-3.0spdx.org/licenses/GPL-3.0.html ↗Réussi
- Commit ou version publiée au cours de l'année écouléeLast commit or release 2026-11-12github.com/coderrob/backstage-mcp-server ↗Réussi
- OpenSSF ScorecardNon vérifié
- Nom du package non proche d'un package populaireNon vérifié
- Aucun avis critique dans le package ou ses dépendancesNon vérifié
- Aucune instruction cachée destinée au modèle0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersRéussi
- Les outils destructifs sont étiquetésNon vérifié
- Le point de terminaison distant répond à la poignée de main MCPNon vérifié
README
Voir sur GitHubBackstage MCP Server
A type-safe Model Context Protocol server for the Backstage Software Catalog, built on the published @coderrob/mcp-kernel runtime.
It exposes 32 Catalog tools over stdio, uses Backstage's official Catalog client, supports rotating bearer credentials, and ships with black-box SDK and MCP Inspector verification.
What you get
| Capability | Implementation |
|---|---|
| Catalog discovery | Entity queries, references, ancestry, facets, and source locations |
| Catalog operations | Add locations, refresh entities, remove entities or locations, and validate descriptors |
| Type safety | Zod schemas infer handler inputs and emit MCP-compatible JSON Schemas |
| Runtime policies | Timeouts, caller scopes, per-principal rate limits, tagged caching, and invalidation |
| Safe operations | MCP annotations distinguish read-only, mutating, idempotent, and destructive tools |
| Production boundary | Official Backstage CatalogClient, authenticated fetch, redacted stderr logging |
| Verification | Per-file coverage, SDK stdio smoke tests, every-tool execution, and MCP Inspector |
Quick start
1. Install and build
Requirements:
- Node.js 24.15 or newer
- Corepack
- A reachable Backstage backend and an accepted external-access bearer token
corepack enable
corepack yarn install --immutable
corepack yarn build
The Yarn release comes from the packageManager field in package.json; use corepack yarn so local and CI behavior stay aligned.
2. Configure Backstage
Set the backend root or the complete Catalog plugin URL and choose one credential source:
export BACKSTAGE_BASE_URL=https://backstage.example.com
export BACKSTAGE_TOKEN=your-token
For externally rotated credentials, point to a token file instead:
export BACKSTAGE_BASE_URL=https://backstage.example.com
export BACKSTAGE_TOKEN_FILE=/run/secrets/backstage-token
BACKSTAGE_TOKEN_FILE takes precedence when both variables are present and is reread for every outgoing request. Optional LOG_LEVEL=debug enables diagnostic logging. Logs always go to stderr because stdout carries MCP protocol traffic.
3. Start the stdio server
corepack yarn start
The process waits for an MCP client on stdin/stdout. For a read-only check against a real deployment, use corepack yarn test:live; see live Backstage verification.
Connect an MCP client
After building, configure a stdio client with an absolute path:
{
"mcpServers": {
"backstage": {
"command": "node",
"args": ["/absolute/path/to/backstage-mcp-server/dist/cli.cjs"],
"env": {
"BACKSTAGE_BASE_URL": "https://backstage.example.com",
"BACKSTAGE_TOKEN": "your-token"
}
}
}
}
After global installation, use backstage-mcp-server as the command. Do not place credentials in committed client configuration; use the client's secret or environment mechanism where available.
Tool catalog
The checked-in tools-manifest.json is generated from the runtime definitions and is the machine-readable source of truth.
| Category | Tools |
|---|---|
| Entity discovery | get_entities, get_entities_by_query, get_entities_by_refs, get_entity_by_ref, get_entity_ancestors, get_entity_facets |
| Location discovery | get_location_by_entity, get_location_by_ref |
| Validation | validate_entity |
| Catalog mutation | add_location, refresh_entity |
| Destructive mutation | remove_entity_by_uid, remove_location_by_id |
get_entities.filter follows Backstage's key-value model: keys in one record are AND conditions, values for one key are OR conditions, and multiple records are OR groups.
{
"filter": {
"kind": ["Component", "API"],
"metadata.namespace": "default"
}
}
This selects Components or APIs in the default namespace. The Backstage integration guide documents every tool-to-client mapping, cursor behavior, authentication, permissions, and error conversion.
How it works
- An MCP client launches the packaged CLI and exchanges JSON-RPC over stdio.
- The published MCP Kernel validates and compiles immutable feature definitions.
- Zod validates input before middleware, authorization, caching, rate limiting, and timeout policies run.
- A Backstage tool calls the typed Catalog contract from its application context.
- The adapter delegates HTTP behavior to the official Backstage
CatalogClientand injects the bearer token at the fetch boundary. - Results return as MCP text plus structured content; expected failures use stable error codes and safe details.
The published @coderrob/mcp-kernel package owns protocol registration, lifecycle, policies, transports, testing support, and protocol-safe logging. This repository owns only the Backstage application and Catalog integration. See the current architecture overview for the dependency boundary.
MCP Kernel dependency
Generic server authoring, lifecycle, policies, transports, results, testing support, and logging are documented in the @coderrob/mcp-kernel repository. This package re-exports the kernel API for compatibility, but new generic consumers should install and import @coderrob/mcp-kernel directly.
To contribute a Catalog capability, follow Adding a Backstage MCP tool.
Verification

Run the normal contributor gate:
corepack yarn lint
corepack yarn typecheck
corepack yarn architecture:check
corepack yarn knip
corepack yarn test
corepack yarn test:shell
For MCP, tool, adapter, or packaging changes, also run:
corepack yarn test:mcp
corepack yarn manifest:check
test:mcp runs contract tests, builds the distribution, launches dist/cli.cjs over stdio with the official SDK client, invokes every registered tool against a deterministic authenticated Catalog stub, and performs an independent MCP Inspector check. It does not bypass the server with direct handler or HTTP calls.
See Repository tooling for the purpose and side effects of every command and MCP end-to-end testing for the exact black-box boundary.
Documentation
Choose a path from the documentation hub:
- Operate it: Backstage integration and end-to-end testing
- Develop it: Repository tooling, code quality, and adding tools
- Understand it: Architecture overview, ADRs, historical analysis, and implementation plan
- Maintain it: Dependency management
License
GPL-3.0. See LICENSE.
Curated knowledge and skills
The Backstage knowledge base maintains classified articles, named source citations and schema.org metadata. Repository skills in .agents/skills support catalog lookups, entity maintenance and MCP development.
The 19 contextual lookup tools cover names, System and Domain contents, Groups, ownership, dependencies, APIs, annotations and orphaned entities. See lookup contracts and examples, including pagination, ambiguity and work bounds.
Questions sur Backstage MCP
Comment configurer l'authentification pour le serveur Backstage ?
Vous pouvez fournir un jeton bearer via la variable d'environnement BACKSTAGE_TOKEN ou pointer vers un fichier de jeton en utilisant BACKSTAGE_TOKEN_FILE.
Quel type d'opérations sur le catalogue l'IA peut-elle effectuer ?
Le serveur propose des outils pour la découverte d'entités, la découverte de localisations, la validation d'entités et des mutations du catalogue telles que l'ajout, l'actualisation ou la suppression d'entités et de localisations.
Puis-je utiliser ce serveur avec un déploiement Backstage réel ?
Oui, vous pouvez effectuer une vérification en lecture seule sur un déploiement réel en utilisant la commande test:live.
Quels sont les prérequis système pour l'installation ?
Vous avez besoin de Node.js version 24.15 ou plus récente et de Corepack installé.