Skip to main content

SkyForge MCP Server - Model Context Protocol server for SkySpark/Haxall/Haystack systems

Project description

Skyforge MCP Server

⚠️ ALPHA RELEASE - This is an early alpha version. Expect bugs and breaking changes.

🚫 NOT FOR PRODUCTION - This is a development/experimental version. For a production implementation, please contact james@skyforge-labs.com

🔓 NO AUTHENTICATION - This server has no built-in authentication. CORS is wide open (allow_origins=["*"]). Use at your own risk and secure your deployment appropriately.

A Model Context Protocol (MCP) server that connects AI assistants to SkySpark and Haxall building automation systems. Dynamically exposes your SkySpark Axon functions as MCP tools.

Features

  • Dynamic Axon Tools - Fetches tool definitions from SkySpark at runtime
  • Prompt Support - Expose templated prompts from SkySpark
  • Dual Transport - Supports stdio (Claude Desktop) and HTTP/SSE (web clients)
  • Type Safety - Full Haystack type system with automatic JSON Schema conversion
  • Docker Ready - Simple Docker deployment included

How It Works

The server fetches tools from SkySpark on each list_tools request. This means:

  • Add new tools by creating Axon functions in SkySpark
  • No server restart needed for schema changes
  • SkySpark is your single source of truth

Quick Start

Prerequisites

  • SkySpark or Haxall server with API access
  • Docker (recommended) OR Python 3.12+ with uv

Install from PyPI

Once published, you can install directly:

pip install skyforge-mcp

# Run stdio entry (console script)
skyforge-mcp-stdio

# Or run package via module (also stdio)
python -m skyforge_mcp

Environment variables (required by all modes):

export SKYSPARK_URI=http://host.docker.internal:8082/api/demo
export SKYSPARK_USERNAME=su
export SKYSPARK_PASSWORD=su

Quick Setup with Example Tools

For immediate testing, import the included setup.zinc file into your SkySpark project. This provides example MCP tools and the required fetchMcpTools() function.

Docker Setup (Easiest)

  1. Clone and configure

    git clone https://github.com/yourusername/skyforge-mcp.git
    cd skyforge-mcp
    
    # Create .env file
    cat > .env << EOF
    SKYSPARK_URI=http://host.docker.internal:8080/api/demo
    SKYSPARK_USERNAME=your_username
    SKYSPARK_PASSWORD=your_password
    EOF
    
  2. Start server

    docker-compose up --build
    

    Server runs on http://localhost:8000/mcp

  3. Test with MCP Inspector

    npx @modelcontextprotocol/inspector docker exec -it skyspark-mcp-server uv run main.py
    

Local Setup (Development)

  1. Install and run
    # Install uv package manager
    curl -LsSf https://astral.sh/uv/install.sh | sh
    
    # Clone and setup
    git clone https://github.com/yourusername/skyforge-mcp.git
    cd skyforge-mcp
    uv sync
    
    # Create .env (same as above)
    

Run HTTP/SSE mode (for web clients)

uv run main.py

Or stdio mode directly (same as pip/console-script behavior)

uv run python -m skyforge_mcp


## Claude Desktop Integration (stdio)

This server is designed to run as an MCP stdio server when used with Claude Desktop. You can run it through Docker Compose.

Edit your Claude Desktop config:
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`

Pick one of the options below.

### Option A — Use cwd (project working directory)
```json
{
"mcpServers": {
 "skyforge-mcp": {
   "type": "stdio",
   "command": "docker",
   "args": ["compose","run","--rm","skyforge-mcp","uv","run","skyforge-mcp-stdio"],
   "cwd": "C:\\\\Users\\\\YOUR_USER\\\\Documents\\\\SkyForge labs\\\\GitHub\\\\skyforge-mcp",
   "env": {
     "SKYSPARK_URI": "http://host.docker.internal:8082/api/demo",
     "SKYSPARK_USERNAME": "su",
     "SKYSPARK_PASSWORD": "su"
   }
 }
}
}

Option B — Pass the compose file path explicitly (works from any cwd)

{
  "mcpServers": {
    "skyforge-mcp": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "compose","-f","C:\\\\Users\\\\YOUR_USER\\\\Documents\\\\SkyForge labs\\\\GitHub\\\\skyforge-mcp\\\\docker-compose.yml",
        "run","--rm","skyforge-mcp","uv","run","skyforge-mcp-stdio"
      ],
      "env": {
        "SKYSPARK_URI": "http://host.docker.internal:8082/api/demo",
        "SKYSPARK_USERNAME": "su",
        "SKYSPARK_PASSWORD": "su"
      }
    }
  }
}

Notes:

  • Replace YOUR_USER and the path to match your machine.
  • On Windows JSON, backslashes must be escaped (\\).
  • Restart Claude Desktop after saving the config.

Cursor MCP (stdio) configuration

Add to Cursor settings (MCP servers). This uses the PyPI package if installed:

{
  "mcpServers": {
    "skyforge-mcp": {
      "command": "python",
      "args": ["-m", "skyforge_mcp"],
      "env": {
        "SKYSPARK_URI": "https://skyspark.skyforge.app/api/skyforgeMcp",
        "SKYSPARK_USERNAME": "skycode",
        "SKYSPARK_PASSWORD": "skycode"
      }
    }
  }
}

Cursor MCP Integration

Add this to your Cursor MCP configuration to run via stdio:

{
  "mcpServers": {
    "skyforge-mcp": {
      "command": "python",
      "args": ["-m", "skyforge_mcp.stdio"],
      "env": {
        "SKYSPARK_URI": "https://skyspark.skyforge.app/api/skyforgeMcp",
        "SKYSPARK_USERNAME": "skycode",
        "SKYSPARK_PASSWORD": "skycode"
      }
    }
  }
}

Alternatively, after pip install skyforge-mcp, you can use the console script:

{
  "mcpServers": {
    "skyforge-mcp": {
      "command": "skyforge-mcp-stdio",
      "env": {
        "SKYSPARK_URI": "https://skyspark.skyforge.app/api/skyforgeMcp",
        "SKYSPARK_USERNAME": "skycode",
        "SKYSPARK_PASSWORD": "skycode"
      }
    }
  }
}

Creating SkySpark Tools

In SkySpark, implement fetchMcpTools() to return tool definitions as a grid. Each row should have:

  • name - Tool identifier (Str)
  • dis - Display name (Str)
  • help - Description (Str)
  • params - Parameter schema (Dict or List)

Example in SkySpark:

// Return MCP tools grid
fetchMcpTools: () => [
  {
    name: "getSiteEquips",
    dis: "Get Site Equipment", 
    help: "Returns all equipment for a site",
    params: {
      kind: "Dict",
      params: {
        siteId: {
          kind: "Ref",
          help: "Site reference ID",
          required: marker()
        }
      }
    }
  }
].toGrid

// Tool implementation (called via `call()`)
getSiteEquips: (dict) => readAll(equip and siteRef == dict->siteId)

Import the included setup.zinc file into your SkySpark project for example tools and the required fetchMcpTools() function.

The server fetches tools automatically when clients call list_tools.

Configuration

Create .env file:

# For Docker: use host.docker.internal to access host machine
SKYSPARK_URI=http://host.docker.internal:8080/api/demo
# For local development: use localhost
# SKYSPARK_URI=http://localhost:8080/api/demo
SKYSPARK_USERNAME=your_username
SKYSPARK_PASSWORD=your_password

All three variables are required.

Project Structure

skyforge-mcp/
├── app/
│   ├── skyspark/         # SkySpark integration
│   │   ├── client.py     # Phable-based API client
│   │   ├── converters.py # Haystack ↔ JSON Schema conversion
│   │   ├── grid.py       # HGrid wrapper for dual format output
│   │   └── types.py      # Extended Haystack types
│   └── tools/
│       └── axon_tools.py # Hardcoded tool examples
├── main.py              # MCP server entry point
├── docker-compose.yml   # Docker setup
└── Dockerfile           # Container definition

Troubleshooting

Connection errors:

  • Docker: Use host.docker.internal instead of localhost in SKYSPARK_URI
  • Verify SkySpark URI is accessible: curl http://your-server:8080/api/demo
  • Check .env credentials
  • Ensure SkySpark API is enabled

No tools appearing:

  • Verify fetchMcpTools() function exists in SkySpark
  • Check server logs: docker-compose logs or uv run main.py
  • Test with MCP Inspector

Docker issues:

docker-compose logs              # View logs
docker-compose restart           # Restart
docker-compose up --build        # Rebuild

Security Notes

⚠️ Important:

  • This is NOT for production use - if you are interested in a production implementation, contact james@skyforge-labs.com
  • No built-in authentication - secure your network/deployment
  • CORS allows all origins - intended for local development
  • Store credentials securely (.env files, environment variables)
  • For production, add authentication middleware or use VPN/firewall

Credits & License

Built with:

License: MIT - see LICENSE file

Contributing

Issues and PRs welcome! This is an alpha release - feedback appreciated.

Repository: GitHub

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skyforge_mcp-0.1.1.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skyforge_mcp-0.1.1-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file skyforge_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: skyforge_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for skyforge_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fe38eb48b3c7ebba3b334d397475817ee5a650cdf4a09dd9876b378237fdaa0f
MD5 2d4434ba763282770acfba9f6a5f7a73
BLAKE2b-256 04f13f3f506775d70922071cd8e1d5caec21a2bea94f87734ac4ef84e760a8a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for skyforge_mcp-0.1.1.tar.gz:

Publisher: publish.yml on skyforge-labs/skyforge-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file skyforge_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: skyforge_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for skyforge_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2ba1224d97c457da61e7a2dea57f2f0c66ced0b2f49f886f0c72cd5d9a255144
MD5 67a190cda5b5bebfb595658bb7bfdb65
BLAKE2b-256 1c8f6b3830d3b721ecabacfeaaba6c392ae554024aad51d3002a1707aa68b911

See more details on using hashes here.

Provenance

The following attestation bundles were made for skyforge_mcp-0.1.1-py3-none-any.whl:

Publisher: publish.yml on skyforge-labs/skyforge-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page