lmstudio-installer-gen

Crates.iolmstudio-installer-gen
lib.rslmstudio-installer-gen
version1.0.0
created_at2025-09-01 04:15:00.98712+00
updated_at2025-09-01 04:15:00.98712+00
descriptionGenerate one-click LM Studio MCP installers from JSON configuration
homepagehttps://samscarrow.github.io/mcp-servers-lmstudio
repositoryhttps://github.com/samscarrow/lmstudio-installer-gen
max_upload_size
id1819101
size144,496
Sam Scarrow (samscarrow)

documentation

https://docs.rs/lmstudio-installer-gen

README

lmstudio-installer-gen

Generate one-click LM Studio MCP installers from JSON configuration files.

Features

  • 🚀 Generate beautiful HTML installers from JSON
  • 🎨 Multiple templates (Modern, Minimal)
  • 📦 Automatic deeplink generation for LM Studio
  • 🌐 GitHub Pages deployment support
  • 🔧 CLI with validation and testing
  • 📝 JSON schema validation
  • 🎯 Support for stdio and SSE server types

Installation

cargo install lmstudio-installer-gen

Quick Start

  1. Create a sample configuration:
lmstudio-installer-gen init
  1. Edit installer-config.json to customize your installer

  2. Generate the installer:

lmstudio-installer-gen generate installer-config.json
  1. (Optional) Deploy to GitHub Pages:
export GITHUB_TOKEN=your_token_here
lmstudio-installer-gen deploy your-installer.html --repo owner/repo

Configuration Format

{
  "name": "My LM Studio MCP Server",
  "description": "A powerful MCP server for LM Studio integration",
  "version": "1.0.0",
  "author": {
    "name": "Your Name",
    "email": "your.email@example.com",
    "url": "https://github.com/yourusername"
  },
  "server": {
    "type": "stdio",
    "command": "python3",
    "args": ["/path/to/your/server.py"],
    "env": {
      "LMSTUDIO_API_BASE": "http://localhost:1234/v1"
    }
  },
  "deployment": {
    "github": {
      "repository": "username/repository",
      "branch": "gh-pages",
      "path": "installers"
    },
    "output": {
      "template": "modern",
      "theme": {
        "primary_color": "#667eea",
        "secondary_color": "#764ba2"
      }
    }
  },
  "features": {
    "prerequisites": [
      {
        "name": "Python 3.7+",
        "check_command": "python3 --version",
        "install_url": "https://python.org/downloads",
        "required": true
      }
    ],
    "post_install": [
      {
        "type": "message",
        "content": "🎉 Installation complete!"
      }
    ]
  },
  "metadata": {
    "tags": ["ai", "llm", "mcp"],
    "license": "MIT",
    "homepage": "https://github.com/yourusername/your-mcp-server"
  }
}

CLI Commands

Generate an installer

lmstudio-installer-gen generate config.json -o output.html

Validate configuration

lmstudio-installer-gen validate config.json

Deploy to GitHub Pages

lmstudio-installer-gen deploy installer.html --repo owner/repo

Create sample config

lmstudio-installer-gen init

Server Types

Stdio Server

{
  "server": {
    "type": "stdio",
    "command": "python3",
    "args": ["server.py"],
    "env": {
      "API_KEY": "value"
    }
  }
}

SSE Server

{
  "server": {
    "type": "sse",
    "url": "https://api.example.com/sse",
    "headers": {
      "Authorization": "Bearer token"
    }
  }
}

Templates

  • Modern: Beautiful gradient design with cards and animations
  • Minimal: Clean, simple design focused on functionality

License

MIT

Author

Sam Scarrow sam@scarrow.io

Commit count: 0

cargo fmt