edge-connect-mcp/QUICKSTART.md

Quick Start Guide

Get up and running with the Edge Connect MCP Server in 5 minutes.

Prerequisites

• Go 1.25.3 or later
• Edge Connect API credentials
• Claude Code CLI or Claude Desktop

Installation

1. Build the Server

git clone <repository-url>
cd edge-connect-mcp
make build

2. Configure Environment

Create a .env file from .env.example, or export environment variables:

export EDGE_CONNECT_BASE_URL="https://hub.apps.edge.platform.mg3.mdb.osc.live"
export EDGE_CONNECT_AUTH_TYPE="credentials"
export EDGE_CONNECT_USERNAME="your-username"
export EDGE_CONNECT_PASSWORD="your-password"
export EDGE_CONNECT_DEFAULT_REGION="EU"

3. Test the Server

# Verify it starts without errors
./edge-connect-mcp
# Alternatively:
make run
# Kill it with Ctrl+C after verifying

Integration

Option A: Claude or Claude Desktop locally (Recommended)

Edit your config file:

Claude Desktop: ~/Library/Application Support/Claude/claude_desktop_config.json Claude Code: ~/.claude.json

{
  "mcpServers": {
    "edge-connect": {
      "command": "/path/to/edge-connect-mcp",
      "env": {
        "EDGE_CONNECT_BASE_URL": "https://hub.apps.edge.platform.mg3.mdb.osc.live",
        "EDGE_CONNECT_AUTH_TYPE": "credentials",
        "EDGE_CONNECT_USERNAME": "your-username",
        "EDGE_CONNECT_PASSWORD": "your-password",
        "EDGE_CONNECT_DEFAULT_REGION": "EU"
      }
    }
  }
}

Restart Claude Desktop or Claude Code to load the server.

Option B: Claude Code locally (not currently working)

# Add the server
claude mcp add edge-connect ./edge-connect-mcp

# Configure it (use absolute path to binary)
claude mcp edit edge-connect --set command=$(pwd)/edge-connect-mcp

# Set credentials
claude mcp edit edge-connect --set-env EDGE_CONNECT_BASE_URL=https://hub.apps.edge.platform.mg3.mdb.osc.live
claude mcp edit edge-connect --set-env EDGE_CONNECT_AUTH_TYPE=credentials
claude mcp edit edge-connect --set-env EDGE_CONNECT_USERNAME=your-username
claude mcp edit edge-connect --set-env EDGE_CONNECT_PASSWORD=your-password
claude mcp edit edge-connect --set-env EDGE_CONNECT_DEFAULT_REGION=EU

# Verify
claude mcp list
claude mcp test edge-connect

Option C: Remote Server (http communication)

For remote access:

# Generate a secure token
export MCP_REMOTE_AUTH_REQUIRED=true
export MCP_REMOTE_AUTH_TOKENS=$(openssl rand -base64 32)

# Start remote server
./edge-connect-mcp -mode remote -host 0.0.0.0 -port 8080

# Connect from any client to:
# http://your-server:8080/sse

Usage Examples

Once configured, you can ask Claude to manage Edge Connect resources:

Create an Application

Please create an Edge Connect app:
- Organization: my-org
- Name: my-nginx-app
- Version: 1.0.0
- Deployment: kubernetes
- Image: https://registry-1.docker.io/library/nginx:latest
- Ports: tcp:80
- Flavor: EU.small

List Applications

Show me all apps in the my-org organization

Create an App Instance

Deploy my-nginx-app version 1.0.0 from my-org to cloudlet:
- Instance name: nginx-prod-01
- Cloudlet org: cloudlet-provider
- Cloudlet name: eu-west-1
- Flavor: EU.small

List App Instances

Show me all running app instances for my-nginx-app

Available Tools

The MCP server provides 11 tools:

Apps Management:

• create_app - Create a new application
• show_app - Get application details
• list_apps - List/filter applications
• update_app - Update an application
• delete_app - Delete an application

App Instance Management:

• create_app_instance - Deploy an app instance
• show_app_instance - Get instance details
• list_app_instances - List/filter instances
• update_app_instance - Update an instance
• refresh_app_instance - Refresh instance state
• delete_app_instance - Delete an instance

Troubleshooting

Server won't start

# Check credentials
echo $EDGE_CONNECT_USERNAME

# Test manually
EDGE_CONNECT_BASE_URL=https://hub.apps.edge.platform.mg3.mdb.osc.live \
EDGE_CONNECT_AUTH_TYPE=credentials \
EDGE_CONNECT_USERNAME=your-username \
EDGE_CONNECT_PASSWORD=your-password \
./edge-connect-mcp

Claude Code doesn't see the server

# Check if it's registered
claude mcp list

# View detailed status
claude mcp status edge-connect

# Check logs
claude mcp logs edge-connect

Authentication errors

Verify your credentials work:

curl -u "your-username:your-password" \
  https://hub.apps.edge.platform.mg3.mdb.osc.live/api/v1/auth/ctrl/ShowApp \
  -H "Content-Type: application/json" \
  -d '{"App":{"key":{"organization":"test","name":"test","version":"1.0.0"}},"Region":"EU"}'

Next Steps

• Read README.md for detailed documentation
• Check REMOTE_SERVER.md for remote deployment
• Review .env.example for all configuration options
• See the security guidelines for production deployments

Support

For issues or questions:

• Check the README.md for detailed docs
• Review error messages carefully
• Verify credentials and network connectivity
• Ensure you're using Go 1.25.3+

Quick Commands Reference

# Build
go build -o edge-connect-mcp

# Run locally (stdio)
./edge-connect-mcp

# Run remotely (HTTP/SSE)
./edge-connect-mcp -mode remote -port 8080

# Add to Claude Code
claude mcp add edge-connect
claude mcp edit edge-connect --set command=$(pwd)/edge-connect-mcp
claude mcp test edge-connect

# View help
./edge-connect-mcp -h