MMCPMarkets
PM

pawelwaj/mcp

API 开发

本页由 AI 翻译，技术细节请以原文为准。 查看原文

2 stars 2 forks 质量 45 趋势 8
Repository Install

MCP Servers

概览

The MCP server is essentially a complete Backstage consultant in your development environment! 🚀 A comprehensive Model Context Protocol (MCP) server providing extensive knowledge about Backstage for plugin development and customization. - : Core concepts, features, benefits, and architecture - : Complete guide for creating custom plugins - : REST endpoints, GraphQL APIs, and client libraries - : Discord channels, common questions, and learning materials - : Practical examples for common development scenarios - : Generate plugin templates with custom configurations Get comprehensive overview of Backstage framework. - Optional section parameter: whatIsBackstage, coreFeatures, benefits, architecture Get detailed plugin development guide. - Optional topic parameter: overview, gettingStarted, pluginStructure, commonPatterns, apis, testing, deployment, bestPractices Get Backstage API reference documentation.

README

以下为原文 README 节选，完整内容请查看原文。

Backstage MCP Server

The MCP server is essentially a complete Backstage consultant in your development environment! 🚀

A comprehensive Model Context Protocol (MCP) server providing extensive knowledge about Backstage for plugin development and customization.

Features

This MCP server provides access to:

  • Backstage Overview: Core concepts, features, benefits, and architecture
  • Plugin Development Guide: Complete guide for creating custom plugins
  • API Reference: REST endpoints, GraphQL APIs, and client libraries
  • Community Resources: Discord channels, common questions, and learning materials
  • Code Examples: Practical examples for common development scenarios
  • Plugin Scaffolding: Generate plugin templates with custom configurations

Available Tools

1. get_backstage_overview

Get comprehensive overview of Backstage framework.

  • Optional section parameter: whatIsBackstage, coreFeatures, benefits, architecture

2. get_plugin_development_guide

Get detailed plugin development guide.

  • Optional topic parameter: overview, gettingStarted, pluginStructure, commonPatterns, apis, testing, deployment, bestPractices

3. get_api_reference

Get Backstage API reference documentation.

  • Optional api parameter: catalogApi, scaffolderApi, techDocsApi, authApi, searchApi, proxyApi, graphqlApi

4. get_community_resources

Get community resources and support information.

  • Optional category parameter: officialChannels, communityPlugins, commonQuestions, learningResources, adoptionStories, contributing

5. get_backstage_examples

Get code examples and samples.

  • Optional type parameter: pluginExamples, catalogExamples, templateExamples, configExamples
  • Optional specific parameter for specific examples within a type

6. search_backstage_knowledge

Search across all knowledge bases.

  • Required query parameter: search terms

7. get_plugin_scaffold_template

Generate plugin scaffold templates.

  • Required pluginType: frontend, backend, fullstack, common
  • Required pluginName: name of your plugin
  • Optional features array: routing, api-client, entity-provider, scaffolder-action, search-collator

Installation

# Quick setup
./setup.sh

# Or manual setup
npm run docker:compose:up

Usage

With Cursor/Claude Desktop (Docker)

Add to your MCP configuration:

{
  "mcpServers": {
    "backstage": {
      "command": "docker",
      "args": ["exec", "-i", "backstage-mcp-server", "node", "dist/index.js"]
    }
  }
}

Sharing with Friends

See SHARING_GUIDE.md for complete instructions on sharing this server with friends.

Knowledge Base Coverage

  • Core Backstage Concepts: Software Catalog, Templates, TechDocs, Plugins
  • Plugin Development: Frontend, backend, and full-stack plugin creation
在 GitHub 查看完整 README

安装

docker exec -i backstage-mcp-server node dist/index.js
新手？先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "backstage": { "command": "docker", "args": ["exec", "-i", "backstage-mcp-server", "node", "dist/index.js"] } } }