rive -core

Rive MCP Server - Core System provides a centralized orchestration layer for Rive animations. It discovers, indexes, and orchestrates Rive assets across libraries, and exposes framework-specific runtime surfaces so consumer applications (React, Vue, Stencil, etc.) can integrate animations with minimal boilerplate. The server also supports multi-backend storage (local filesystem, S3, or remote CDN) and offers code-generation features to produce production-ready wrappers for various frameworks. Typical workflows include listing components, inspecting details, retrieving runtime surfaces for a chosen framework, composing multi-component scenes, and generating wrapper components for quick integration.

To use the server, start it in your environment and connect your client tooling to the exposed MCP tools. For example, you can list available components, fetch a React runtime surface for a component, or compose a scene that strings multiple components together. The server will also output a client configuration snippet you can paste into your app so that your client-side code can initialize and render the correct animations with proper assets and manifests.

Prerequisites:

• Node.js (LTS version) and npm installed on your machine
• Git for cloning or updating the repository

1. Install dependencies

• Clone the repository if you haven't already: git clone <repository-url> cd rive-mcp-server-core

• Install npm dependencies for the monorepo (workspaces assumed): npm install

2. Build the packages (example as per Quick Start) npm run build:packages

3. Initialize storage (creates local data folders for development) npm run init-storage

4. Validate configuration npm run validate-setup

5. Start the MCP server npm run mcp-server

If you are deploying in a different environment, ensure the server's config.json or environment variables are set according to your storage backend and deployment needs.

Tips and common issues:

• Ensure your storage backend is properly configured before starting the server (local storage works well for development; switch to s3 or remote when in production).
• The MCP server exposes several tools (listComponents, getComponentDetail, getRuntimeSurface, composeScene, generateWrapper). Use the commands and sample payloads described in the README to interact with these tools.
• If you modify configuration or storage, re-run npm run validate-setup to verify the environment.
• When generating wrappers, specify the target framework and TypeScript usage to produce ready-to-use components for your client app.
• For production deployments, consider containerizing the server (Docker) and configuring persistent storage for manifests and assets.
• Review ARCHITECTURE.md and QUICKSTART.md for detailed design rationale and step-by-step usage examples.