3d MCP

🚀 3D-MCP Architecture Overview

3D-MCP is an innovative project aiming to unify various 3D software through a single API. The project adopts a modular and hierarchical design approach, making expansion and maintenance efficient and orderly.

🚀 Quick Start

Installation

bun install

Running Examples

bun run examples/hello-world.ts

Writing Plugins

1. Create a new plugin:

   npm init -y my-plugin
   

2. Implement the adapter logic.
3. Package and distribute.

✨ Features

3D-MCP is designed to unify various 3D software through a single API. It uses a modular and hierarchical design approach, which effectively isolates each functional domain and ensures high scalability and maintainability of the system.

📦 Installation

bun install

💻 Usage Examples

Basic Usage

# Install dependencies
bun install

# Run the example
bun run examples/hello-world.ts

📚 Documentation

For further details on the implementation of 3D-MCP, please refer to the following documents:

• API Reference
• Development Guide
• Plugin Writing Tutorial

🔧 Technical Details

Overall Architecture

The core concept of 3D-MCP is to divide the system into multiple independent components, each responsible for a specific functional domain. This design not only improves the maintainability of the system but also makes cross - platform development easier.

Core Components

1. Entity Definition: The basic entities shared by all functional domains are managed uniformly in core/entity.ts.
2. Atomic Operations: Atomic operations for specific functional domains are stored in their respective files (e.g., atomic.ts).
3. Compound Operation Generators: High - level compound tools are automatically generated by combining atomic operations and are located in the compounded.ts file.

Functional Modules

• Core Module: Provides basic entities and tools shared by all domains.
• Modeling Module: Handles mesh creation, editing, and topological operations.
• Animation Module: Manages animation - related functions such as keyframes, curves, and segments.
• Binding Module: Responsible for the skeletal system, control hierarchy, and deformation operations.
• Rendering Module: Configures materials, lighting, and rendering settings.

Hierarchical Design

3D-MCP adopts a four - layer architecture, with each layer having a clear division of responsibilities:

1. Presentation Layer: Handles data serialization and deserialization to ensure data compatibility between different platforms.
2. Service Layer: Encapsulates core business logic and provides a unified API interface.
3. Persistence Layer: Implements data storage and retrieval functions, supporting multiple storage schemes.
4. Adapter Layer: Responsible for the integration of specific 3D software, extending the system through plugins.

Domain Organization

Each functional module is organized according to a specific workflow:

Core Components

• Basic Entities: The basic data structure shared by all domains is defined in core/entity.ts.
• General Tools: Provides shared functions and utilities for cross - domain use, located in utils.ts.

Modeling Domain

• Entity Definition: Contains definitions of core modeling concepts such as meshes, vertices, and faces.
• Atomic Operations: Basic operations such as mesh creation and topological modification.
• Compound Tools: Provides advanced modeling functions, such as Boolean operations and subdivision surfaces.

Animation Domain

• Entity Definition: Covers animation - related concepts such as keyframes, animation curves, and segments.
• Atomic Operations: Basic animation controls such as keyframe insertion and curve adjustment.
• Compound Tools: Supports complex animation logic orchestration, such as layered animations and conditional judgments.

Binding Domain

• Entity Definition: Contains binding - related concepts such as skeletons, IK chains, and control hierarchies.
• Atomic Operations: Basic binding operations such as joint creation and constraint addition.
• Compound Tools: Provides advanced binding functions, such as automatic weight painting and deformation target management.

Rendering Domain

• Entity Definition: Involves cameras, light sources, and rendering settings.
• Atomic Operations: Basic rendering controls such as material creation and lighting configuration.
• Compound Tools: Supports complex rendering logic orchestration, such as global illumination settings and post - processing effect overlay.

Entity - Centric CRUD Architecture

3D-MCP adopts an entity - centric design concept, with each domain having its unique entity model. These entities are defined through Zod schema, and CRUD (Create, Read, Update, Delete) operations are automatically generated, greatly improving development efficiency.

Core Components

• Basic Entities: Managed uniformly in core/entity.ts.
• Shared Functions: Provides shared functions and utilities for cross - domain use.