Backstage MCP

🚀 Backstage MCP Backend

This is an example that uses Backstage and MCP, implemented through Quarkus Backstage. The server has been tested with Goose. Here is the detailed information.

🚀 Quick Start

This project is an example implementation that combines Backstage and MCP. It allows users to list available Backstage templates and instantiate templates from the command line.

✨ Features

• List available Backstage templates.
• Instantiate a template from the command line.

📦 Installation

Prerequisites

You need to install Backstage and enable service-to-service communication in this installation. Users need to have access to the tokens used for such communication. The following yaml code snippet shows where and how to set it up:

app:
# ...
backend:
  # ... 
  auth:
    # ...
    externalAccess:
      - type: static
        options:
          token: <Enter your token here>
          subject: curl-requests

🔧 Technical Details

Structure

Dependencies

This project uses the following dependencies:

        <dependency>
            <groupId>io.quarkiverse.mcp</groupId>
            <artifactId>quarkus-mcp-server-stdio</artifactId>
            <version>1.0.0.Alpha5</version>
        </dependency>

It implements an mcp server that reads from standard input and writes to standard output.

It also uses the following dependency:

        <dependency>
            <groupId>io.quarkiverse.backstage</groupId>
            <artifactId>quarkus-backstage</artifactId>
            <version>0.4.1</version>
        </dependency>

This is used to communicate with the Backstage API.

Implementation

The implementation is very simple and only requires one file: [[src/main/java/org/acme/Backstage.java]]

Configure Goose

Goose is a local AI agent that runs as an interactive shell and supports plugins (including the mcp server). To configure Goose to use this mcp server, add the following extension to config.yaml:

  quarkus-backstage-mcp:
    args:
    - --quiet
    - /home/iocanel/demo/backstage-mcp/target/quarkus-app/quarkus-run.jar
    cmd: jbang
    enabled: true
    envs: {}
    name: quarkus-backstage-mcp
    type: stdio

💻 Usage Examples

Basic Usage

List Templates

List all available Backstage templates

Instantiate a Template

To instantiate a template, you need a values.yaml file containing the template parameters. You can extract the default values of the template through the Backstage CLI:

quarkus backstage template info --show-default-values <Template Name>

The output can be saved to a file, such as values.yaml, and then used in a Goose session with the following command for instantiation:

Create a new project from the template <Template Name> using the values in values.yaml