Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![stars](https://img.shields.io/github/stars/db-lyon/ue-mcp)](https://github.com/db-lyon/ue-mcp/stargazers)
[![MIT](https://img.shields.io/npm/l/ue-mcp)](LICENSE)

**Unreal Engine Model Context Protocol Server** - gives AI assistants deep read/write access to the Unreal Editor through <!-- count:tools -->24<!-- /count --> category tools covering <!-- count:actions -->783+<!-- /count --> actions, plus a YAML flow engine for multi-step workflows and an npm plugin system for extending the surface.
**Unreal Engine Model Context Protocol Server** - gives AI assistants deep read/write access to the Unreal Editor through <!-- count:tools -->24<!-- /count --> category tools covering <!-- count:actions -->790+<!-- /count --> actions, plus a YAML flow engine for multi-step workflows and an npm plugin system for extending the surface.

On UE 5.8+ it also wraps Epic's entire native AI Toolset Registry - 830 official Unreal tools, called in-process and surfaced as `epic_*` actions in the matching category: Sequencer in `animation`, PCG in `pcg`, static meshes in `asset`.

Expand Down Expand Up @@ -88,7 +88,7 @@ Nothing is pre-authored. Every asset in the scene is created by the agent at run
| **Blueprints** | Read/write graphs, add nodes, connect pins, compile, CDO and component property access |
| **Materials** | Create materials and instances, author expression graphs, set parameters |
| **Assets** | CRUD, import meshes/textures/animations, datatables, mesh bounds/collision/nav |
| **Animation** | Anim blueprints, montages, blendspaces, skeletons |
| **Animation** | Anim blueprints, montages, retargeting, native Control Rig editing, deterministic pose analysis |
| **VFX** | Niagara systems, emitters, modules, renderers, parameters |
| **Landscape** | Sculpt terrain, paint weight layers, materials, splines, proxies |
| **Foliage** | Painting, foliage types, instance queries |
Expand Down Expand Up @@ -137,7 +137,7 @@ flows:
flow(action="run", flowName="build_and_check")
```

Every one of the <!-- count:actions -->783+<!-- /count --> actions is also a flow task. Flows support step references, retries, rollback, custom tasks in your own `.js`/`.ts`, and shell steps. See [Flows](https://ue-mcp.com/docs/flows/).
Every one of the <!-- count:actions -->790+<!-- /count --> actions is also a flow task. Flows support step references, retries, rollback, custom tasks in your own `.js`/`.ts`, and shell steps. See [Flows](https://ue-mcp.com/docs/flows/).

## Plugins

Expand All @@ -156,6 +156,7 @@ The package ships skills that teach agents the non-obvious parts of driving the
| Skill | Covers |
|-------|--------|
| `ue-mcp-workflow` | Required order of operations, editor lifecycle, project scoping |
| [`ue-mcp-animation`](skills/ue-mcp-animation/SKILL.md) | UE 5.8 IK/retarget authoring, per-rig Control Rig solving, generic contact locks, bake and deterministic V&V |
| `ue-mcp-blueprint` | Graph authoring, node discovery, pin wiring, compile loops |
| `ue-mcp-niagara` | Emitter/module stack authoring and renderer setup |
| `ue-mcp-native-cpp` | Writing and building native C++ against the bridge |
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ The plugin runs a raw WebSocket server on a dedicated thread, dispatches incomin

### Handler Categories

28 C++ handler groups are registered in `BridgeServer.cpp`. Together they expose <!-- count:actions -->783+<!-- /count --> method names (some of which are aliases mapped onto a smaller number of canonical handlers):
28 C++ handler groups are registered in `BridgeServer.cpp`. Together they expose <!-- count:actions -->790+<!-- /count --> method names (some of which are aliases mapped onto a smaller number of canonical handlers):

| Handler group | Coverage |
|---------|----------|
Expand Down
485 changes: 485 additions & 0 deletions docs/control-rig-animation.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The response carries a `summary` line per step plus a `steps` array holding what

### Tasks

A task is a named unit of work. UE-MCP ships with **<!-- count:actions -->783+<!-- /count --> built-in tasks** across <!-- count:tools -->24<!-- /count --> categories - every action available through the MCP tools is also a flow task.
A task is a named unit of work. UE-MCP ships with **<!-- count:actions -->790+<!-- /count --> built-in tasks** across <!-- count:tools -->24<!-- /count --> categories - every action available through the MCP tools is also a flow task.

Tasks are defined in the `tasks:` section of your config:

Expand All @@ -59,7 +59,7 @@ The fields:
| `group` | No | Category for organization |
| `options` | No | Default options passed to the task (can be overridden per-step) |

You rarely need to define tasks yourself - the built-in defaults cover all <!-- count:actions -->783+<!-- /count --> actions. You define tasks when you want to **override** or **add** custom ones.
You rarely need to define tasks yourself - the built-in defaults cover all <!-- count:actions -->790+<!-- /count --> actions. You define tasks when you want to **override** or **add** custom ones.

### Flows

Expand Down Expand Up @@ -633,7 +633,7 @@ Configuration is loaded with [`@db-lyon/flowkit`'s config loader](https://github

| Layer | File | Purpose |
|-------|------|---------|
| 1 (base) | Built-in defaults | All <!-- count:actions -->783+<!-- /count --> tasks, no flows |
| 1 (base) | Built-in defaults | All <!-- count:actions -->790+<!-- /count --> tasks, no flows |
| 2 | `ue-mcp.yml` | Your project config |
| 3 | `ue-mcp.{env}.yml` | Environment overlay (set `UE_MCP_ENV`) |
| 4 | `ue-mcp.local.yml` | Local-only overrides (gitignore this) |
Expand Down
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# UE-MCP

**Unreal Engine Model Context Protocol Server** - lets AI assistants drive the Unreal Editor through <!-- count:tools -->24<!-- /count --> category tools covering <!-- count:actions -->783+<!-- /count --> actions.
**Unreal Engine Model Context Protocol Server** - lets AI assistants drive the Unreal Editor through <!-- count:tools -->24<!-- /count --> category tools covering <!-- count:actions -->790+<!-- /count --> actions.

UE-MCP is a bridge between an AI client (Claude Code, Claude Desktop, Cursor, etc.) and the Unreal Editor. It runs a TypeScript MCP server on your machine, which talks over WebSocket to a C++ plugin running inside the editor. The result: your AI can place actors, write blueprints, author materials, sculpt landscape, set up Niagara VFX, configure replication, run PIE, build the project - anything the editor can do.

Expand All @@ -26,7 +26,7 @@ Start with **[Getting Started](getting-started.md)**. It assumes zero knowledge
| **Blueprints** | Read/write graphs, add nodes, connect pins, compile, CDO property access |
| **Materials** | Create materials and instances, author expression graphs, set parameters |
| **Assets** | CRUD, import meshes/textures/animations, datatables |
| **Animation** | Read/create anim blueprints, montages, blendspaces, skeletons |
| **Animation** | Anim blueprints, montages, retargeting, native Control Rig editing, deterministic pose analysis |
| **VFX** | Create and configure Niagara systems and emitters |
| **Landscape** | Sculpt terrain, paint weight layers, materials, splines, proxies |
| **PCG** | Author and execute Procedural Content Generation graphs |
Expand Down Expand Up @@ -54,6 +54,7 @@ And a **plugin system** that lets npm packages inject new actions into the exist
- **[Getting Started](getting-started.md)** - Zero-to-running walkthrough for first-time users
- **[Architecture](architecture.md)** - How the TypeScript server, C++ plugin, and editor fit together
- **[Tool Reference](tool-reference.md)** - All <!-- count:tools -->24<!-- /count --> tools with every action and its parameters
- **[Native Control Rig Animation](control-rig-animation.md)** - Agent workflow for rig discovery, anatomical solving, quaternion keys, baking, and deterministic V&V
- **[Flows](flows.md)** - Multi-step YAML workflows, custom tasks, hooks, rollback
- **[Plugins](plugins.md)** - npm packages that inject new actions into existing categories
- **[Configuration](configuration.md)** - `ue-mcp.yml` and MCP client config
Expand Down
Loading
Loading