Skip to main content

spline-mcp

Code style: crackerjack Runtime: oneiric Framework: FastMCP uv Python: 3.13+

MCP server for Spline.design code generation and asset management.

Overview

Spline.design is a 3D design tool that exports interactive scenes for the web. This MCP server provides:

  • Code Generation: Generate React, Next.js, and vanilla JS integration code
  • Asset Management: Download, cache, and validate .splinecode files
  • Integration Support: WebSocket (Mahavishnu) integration
  • Helper Utilities: URL building, event documentation, code snippets

Note: Spline does not have a traditional REST API. Scenes are created in the Spline editor and exported as .splinecode files for runtime use.

Spline V2 Compatibility

Spline V2 (released August 20, 2026) ships its own MCP server inside the rebuilt Spline desktop app that lets AI agents drive the editor directly — creating and modifying objects, materials, lights, cameras, booleans, particles, cloners, lathes, sky, variables, events, and states. See the Spline V2 launch announcement for details.

This server fills a different, complementary niche:

Workflow stage Tool
Authoring — building / editing the scene in the editor Spline V2 MCP (bundled with the Spline desktop app)
Embedding — putting the exported scene into your React / Next.js / vanilla app This server (spline-mcp)
Runtime control — manipulating variables / events from your app at runtime Both cooperate: V2 MCP builds the scene; this server emits the JS that drives setNumberVariable() / emitEvent() from the host app

Concretely, this server does not edit scenes — it operates strictly on already-exported .splinecode URLs. If you need an agent to author a new scene from scratch, install the Spline desktop app and use its built-in MCP server. Use this server when you have a published .splinecode URL and want to scaffold the React / Next.js / vanilla integration, cache the scene asset, wire up runtime event handlers, or pipe events into Mahavishnu.

Installation

uv pip install -e .

Quick Start

Generate a React Component

spline-mcp generate react https://prod.spline.design/6Wq1Q7YGyM-iab9i/scene.splinecode

Download a Scene

spline-mcp download https://prod.spline.design/6Wq1Q7YGyM-iab9i/scene.splinecode

MCP Server Usage

Stdio Mode (default)

spline-mcp serve

HTTP Mode

spline-mcp serve --http --port 3048

Available Tools

Code Generation

Tool Description
generate_react_component Generate React component with TypeScript
generate_vanilla_js Generate standalone HTML/JS
generate_nextjs_component Generate Next.js component with SSR support
generate_event_handler Generate event handler code
generate_variable_binding Generate runtime variable bindings
generate_full_integration Complete integration with all features

Asset Management

Tool Description
download_scene Download and cache a .splinecode file
validate_scene Validate a .splinecode file
list_cached_scenes List all cached scenes
clear_cache Clear cached scenes
get_cache_stats Get cache statistics

Helper Utilities

Tool Description
build_export_url Build export URL from scene ID
parse_scene_url Parse URL to extract scene ID
list_event_types List supported Spline event types
get_event_documentation Get docs for specific event
generate_snippet Generate common code snippets

Integration

Tool Description
get_websocket_status Check Mahavishnu WebSocket connection
subscribe_to_channel Subscribe to real-time updates
get_integration_status Status of all integrations
get_integration_status Status of all integrations

Documentation

Tool Description
get_runtime_api_docs Get documentation for the @splinetool/runtime API by topic
get_installation_guide Get installation guide for the Spline runtime
get_troubleshooting_guide Get troubleshooting guide for common Spline issues

Configuration

Set via environment variables with SPLINE_ prefix:

Variable Default Description
SPLINE_DEFAULT_FRAMEWORK react Default framework (react/vanilla/nextjs)
SPLINE_TYPESCRIPT true Generate TypeScript code
SPLINE_LAZY_LOAD true Use lazy loading with Suspense
SPLINE_SSR_PLACEHOLDER false Generate SSR placeholder for Next.js
SPLINE_INDENT_SPACES 2 Indentation spaces for generated code (2-8)
SPLINE_SEMICOLONS true Use semicolons in generated JavaScript
SPLINE_CACHE_DIR ~/.spline-mcp/cache Cache directory
SPLINE_MAX_CACHE_SIZE_MB 500 Maximum cache size
SPLINE_AUTO_VALIDATE true Automatically validate downloaded scenes
SPLINE_WEBSOCKET_ENABLED true Enable WebSocket integration
SPLINE_WEBSOCKET_URL ws://localhost:8690 Mahavishnu WebSocket URL
SPLINE_WEBSOCKET_AUTO_RECONNECT true Automatically reconnect on disconnect
SPLINE_ENABLE_HTTP_TRANSPORT false Enable HTTP transport
SPLINE_HTTP_HOST 127.0.0.1 HTTP server host
SPLINE_HTTP_PORT 3048 HTTP server port
SPLINE_LOG_LEVEL INFO Logging level
SPLINE_LOG_JSON true Use JSON logging format

Generated Code Examples

React Component

import { Suspense, useRef, useCallback } from 'react';
import Spline from '@splinetool/react-spline';

interface HeroSceneProps {
  className?: string;
}

export function HeroScene({ className }: HeroSceneProps) {
  return (
    <Suspense fallback={<div>Loading 3D scene...</div>}>
      <Spline
        scene="https://prod.spline.design/xxx/scene.splinecode"
        className={className}
      />
    </Suspense>
  );
}

With WebSocket Integration

// Auto-generated WebSocket integration with soft failover
const { subscribe, isConnected } = useWebSocket('ws://localhost:8690');

useEffect(() => {
  if (!isConnected) return;

  const unsubscribe = subscribe('spline:variables', (data) => {
    splineRef.current?.setVariables(data);
  });

  return unsubscribe;
}, [isConnected]);

Architecture

spline_mcp/
├── generators/         # Code generation (React, Vanilla, Next.js)
│   ├── base.py         # Base classes and types
│   ├── react.py        # React generator with FastBlocks patterns
│   ├── vanilla.py      # Vanilla JS/HTML generator
│   └── nextjs.py       # Next.js SSR generator
├── assets/             # Asset management
│   ├── manager.py      # Download, cache, validate
│   └── validator.py    # Scene file validation
├── integrations/       # External integrations
│   └── websocket.py    # Mahavishnu WebSocket (soft failover)
├── tools/              # MCP tool definitions
│   ├── generation.py   # Code generation tools
│   ├── assets.py       # Asset management tools
│   ├── helpers.py      # Utility tools
│   └── integration.py  # Integration tools
├── config.py           # Oneiric-based configuration
└── server.py           # FastMCP application

Ecosystem Integration

Part of the Bodai Ecosystem:

Component Role Port
Mahavishnu Orchestrator 8680
Akosha Seer 8682
Dhara Curator 8683
Session-Buddy Builder 8678
Crackerjack Inspector 8676
spline-mcp 3D Orchestrator 3048

Installation via Bodai Marketplace

This repo ships a Bodai Claude Code plugin manifest (.claude-plugin/plugin.json) plus a colocated .mcp.json and three slash commands in commands/. To install via the Bodai marketplace, first register the marketplace with Claude Code, then install the plugin by name. Once installed, the slash commands /spline-generate, /spline-assets, and /spline-websocket become available alongside the mcp__spline__* tools. Make sure the spline-mcp HTTP server is running on its configured port before invoking the slash commands.

License

BSD-3-Clause

Download files

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

Source Distribution

spline_mcp-0.4.1.tar.gz (69.2 kB view details)

Uploaded Source

Built Distribution

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

spline_mcp-0.4.1-py3-none-any.whl (43.0 kB view details)

Uploaded Python 3

File details

Details for the file spline_mcp-0.4.1.tar.gz.

File metadata

  • Download URL: spline_mcp-0.4.1.tar.gz
  • Upload date:
  • Size: 69.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for spline_mcp-0.4.1.tar.gz
Algorithm Hash digest
SHA256 3710ed22dc78042c55913c3e8d43e26d1c9725ec037db5e8e3fa7315571c2451
MD5 656550dc684ad5c7a12dcc397d2130ca
BLAKE2b-256 94bde8914122f28a958560eadae960b0f028b0e2eb3f911884cb1b111af8dfd4

See more details on using hashes here.

File details

Details for the file spline_mcp-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: spline_mcp-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 43.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for spline_mcp-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2d86f31cc5bbf1acbed932f2820400a488edaca6424f772b072a38f91aa9a1d1
MD5 adfeb2ab8a9542fa48883be6c2f93668
BLAKE2b-256 70829215c0505fb7274cebe344f0da28b145a5dba9399059a40222b69b880f49

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.4.1 This release

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

Supported by

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