SHARING_GUIDE.md•4.76 kB
# 🤝 Sharing Backstage MCP Server with Friends
## 📦 What You're Sharing
A complete Backstage knowledge base MCP server that provides:
- **Plugin development guides**
- **API documentation**
- **Community resources**
- **Code examples**
- **Plugin scaffolding tools**
## 🚀 3 Ways to Share
### Method 1: Direct Project Share (Easiest)
**Step 1:** Zip the entire project folder
```bash
# Create a zip file
zip -r backstage-mcp-server.zip /Users/pawel.wajdziak/Documents/Nagarro/Projects/MCP/BACKSTAGE/
```
**Step 2:** Send to friends via email/file sharing
**Step 3:** Friends extract and run:
```bash
unzip backstage-mcp-server.zip
cd BACKSTAGE
npm run docker:compose:up
```
### Method 2: GitHub Repository (Recommended)
**Step 1:** Push to GitHub
```bash
git init
git add .
git commit -m "Initial Backstage MCP server"
git remote add origin https://github.com/yourusername/backstage-mcp-server.git
git push -u origin main
```
**Step 2:** Friends clone and run:
```bash
git clone https://github.com/yourusername/backstage-mcp-server.git
cd backstage-mcp-server
npm run docker:compose:up
```
### Method 3: Docker Hub (Advanced)
**Step 1:** Push to Docker Hub
```bash
# Login to Docker Hub
docker login
# Tag and push
docker tag backstage-mcp-server yourusername/backstage-mcp-server:latest
docker push yourusername/backstage-mcp-server:latest
```
**Step 2:** Friends pull and run:
```bash
docker pull yourusername/backstage-mcp-server:latest
docker run --name backstage-mcp yourusername/backstage-mcp-server:latest
```
## ⚙️ Configuration for Friends
### Cursor/Claude Desktop Setup
Your friends need to add this to their MCP configuration:
```json
{
"mcpServers": {
"backstage": {
"command": "docker",
"args": ["exec", "-i", "backstage-mcp-server", "node", "dist/index.js"]
}
}
}
```
### Configuration File Locations:
**macOS:**
```
~/Library/Application Support/Cursor/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
```
**Windows:**
```
%APPDATA%\Cursor\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json
```
**Linux:**
```
~/.config/Cursor/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
```
## 📋 Prerequisites for Friends
Make sure they have:
- ✅ Docker Desktop installed
- ✅ Cursor or Claude Desktop
- ✅ Basic terminal knowledge
## 🔧 Quick Setup Script for Friends
Create a `setup.sh` file:
```bash
#!/bin/bash
echo "🚀 Setting up Backstage MCP Server..."
# Check if Docker is running
if ! docker info > /dev/null 2>&1; then
echo "❌ Docker is not running. Please start Docker Desktop."
exit 1
fi
# Start the MCP server
echo "📦 Starting Backstage MCP server..."
npm run docker:compose:up
# Check if container is running
if docker ps | grep -q backstage-mcp-server; then
echo "✅ Backstage MCP server is running!"
echo ""
echo "📝 Add this to your Cursor MCP configuration:"
echo '{
"mcpServers": {
"backstage": {
"command": "docker",
"args": ["exec", "-i", "backstage-mcp-server", "node", "dist/index.js"]
}
}
}'
echo ""
echo "🌐 Optional: Web interface available at http://localhost:8080"
else
echo "❌ Failed to start container. Check logs:"
echo "docker logs backstage-mcp-server"
fi
```
## 🧪 Testing Instructions for Friends
After setup, they can test:
```bash
# Check container status
docker ps | grep backstage-mcp
# View logs
docker logs backstage-mcp-server
# Test MCP server
docker exec -i backstage-mcp-server node dist/index.js
```
## 🌐 Optional Web Interface
For friends who want a web interface:
```bash
# Start with web UI
npm run docker:compose:web
# Access at http://localhost:8080
```
## 🆘 Troubleshooting for Friends
### Common Issues:
**1. Container keeps restarting**
```bash
docker logs backstage-mcp-server
# Usually means the MCP server is running correctly (it's designed for stdio)
```
**2. Port 8080 is busy**
```bash
# Edit docker-compose.yml and change port
ports:
- "8081:80" # Use 8081 instead
```
**3. Permission denied**
```bash
sudo docker-compose up -d
```
**4. Can't find docker-compose**
```bash
# Use newer syntax
docker compose up -d
```
## 📞 Support
If friends have issues, they can:
1. Check the `DOCKER_SETUP.md` file
2. Run `docker logs backstage-mcp-server`
3. Contact you with the error logs
## 🎉 What Friends Can Do
Once set up, they can ask questions like:
- "How do I create a Backstage plugin?"
- "Show me API documentation for the catalog"
- "Generate a frontend plugin template"
- "What are the best practices for plugin development?"
The MCP server provides comprehensive Backstage knowledge for plugin development! 🚀