Provides comprehensive knowledge and tools for Backstage development including plugin scaffolding, API reference documentation, code examples, and access to community resources for building and customizing Backstage applications.
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
sectionparameter:whatIsBackstage,coreFeatures,benefits,architecture
2. get_plugin_development_guide
Get detailed plugin development guide.
Optional
topicparameter:overview,gettingStarted,pluginStructure,commonPatterns,apis,testing,deployment,bestPractices
3. get_api_reference
Get Backstage API reference documentation.
Optional
apiparameter:catalogApi,scaffolderApi,techDocsApi,authApi,searchApi,proxyApi,graphqlApi
4. get_community_resources
Get community resources and support information.
Optional
categoryparameter:officialChannels,communityPlugins,commonQuestions,learningResources,adoptionStories,contributing
5. get_backstage_examples
Get code examples and samples.
Optional
typeparameter:pluginExamples,catalogExamples,templateExamples,configExamplesOptional
specificparameter for specific examples within a type
6. search_backstage_knowledge
Search across all knowledge bases.
Required
queryparameter: search terms
7. get_plugin_scaffold_template
Generate plugin scaffold templates.
Required
pluginType:frontend,backend,fullstack,commonRequired
pluginName: name of your pluginOptional
featuresarray:routing,api-client,entity-provider,scaffolder-action,search-collator
Installation
Option 1: Docker (Recommended for Sharing)
Usage
With Cursor/Claude Desktop (Docker)
Add to your MCP configuration:
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
API Integration: REST APIs, GraphQL, client libraries
Community Insights: Discord discussions, common questions, best practices
Real Examples: Working code samples for typical scenarios
Configuration: App config, authentication, integrations
Contributing
This knowledge base is continuously updated with the latest Backstage information. To contribute:
Update knowledge files in
src/knowledge/Add new tools in
src/index.tsTest with real Backstage scenarios
Submit pull requests
Resources
License
Apache 2.0
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
Provides comprehensive Backstage framework knowledge and development assistance through an MCP server. Enables plugin development, API reference access, code scaffolding, and community resource discovery for Backstage customization.