mcp-server-unreal-engine: Instructions file for GitHub Copilot

.github/copilot-instructions.md

mcp-server-unreal-engine copilot-instructions.md is an instructions file for GitHub Copilot from andrewkorot/mcp-server-unreal-engine. It costs 997 tokens per session, scanned A, original, MIT.

A set of coding rules for an Unreal Engine integration that connects a TypeScript tool server to the Unreal Editor through a C++ bridge.

In plain words
What is it for?
Use it when changing the MCP server, Unreal Editor plugin, automation handlers, or tests so new code follows the project's required routes and constraints.
Why use it?
It gives an AI coding assistant project-specific guidance about architecture, safe Unreal Engine 5.7 changes, logging, paths, builds, and tests.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions AGENTS.md.

This is andrewkorot/mcp-server-unreal-engine's own configuration. It tells GitHub Copilot how to work on mcp-server-unreal-engine itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything mcp-server-unreal-engine configures →

Reuse

Borrowing it

Nothing to install: this file belongs to andrewkorot/mcp-server-unreal-engine. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/andrewkorot/mcp-server-unreal-engine/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/andrewkorot/mcp-server-unreal-engine

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for mcp-server-unreal-engine copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/andrewkorot/mcp-server-unreal-engine/copilot-instructions/github.svg)](https://agentmods.dev/instructions/andrewkorot/mcp-server-unreal-engine/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/andrewkorot/mcp-server-unreal-engine/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/andrewkorot/mcp-server-unreal-engine/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for mcp-server-unreal-engine copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/andrewkorot/mcp-server-unreal-engine/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/andrewkorot/mcp-server-unreal-engine/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 997 This file is loaded in full into every session.
When invoked 997 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00997 $0.00997
Opus 5.5 $0.00399 $0.00399
Sonnet 5.5 $0.00199 $0.00199
Haiku 4.5 $0.00100 $0.00100

Measured 1mo ago against content hash 3aa4c408ebc3, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

mcp-server-unreal-engine copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 53 lines

How it starts

The opening of the file, as written. The whole thing — 53 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Copilot instructions for Unreal MCP

Architecture

  • This is a dual-process system: the TypeScript MCP server lives in src/, and the Unreal Editor bridge plugin lives in Plugins/McpAutomationBridge/.
  • Typical flow is schema validation -> tool registry dispatch -> domain handler -> executeAutomationRequest() -> WebSocket bridge -> C++ subsystem -> game-thread handler.
  • Keep workspace-wide guidance here and rely on the closer AGENTS.md files for area-specific detail under src/tools/, src/tools/handlers/, src/automation/, tests/, and Plugins/McpAutomationBridge/.

Critical constraints

  • Keep stdout JSON-only. Runtime logs must go through the project logger; do not use console.log in runtime code. See routeStdoutLogsToStderr() in src/index.ts.
  • .env loading is intentionally quiet to avoid corrupting MCP I/O. Keep it that way in src/config.ts.
  • Do not bypass the tool routing stack. Register tool behavior via toolRegistry.register() and send Unreal work through executeAutomationRequest(), not raw WebSocket calls.
  • Preserve path normalization. Prefer /Game/... asset paths and do not add new code that depends on /Content/... input staying unnormalized.

UE 5.7 safety

  • Do not use UPackage::SavePackage() in plugin code. Use the safe helper wrappers in Plugins/McpAutomationBridge/Source/McpAutomationBridge/Public/McpAutomationBridgeHelpers.h.
  • For Blueprint component templates, let SCS own nodes and templates through CreateNode() and AddNode() patterns.
  • Do not introduce new ANY_PACKAGE usage; use modern lookup patterns such as nullptr where required by newer UE versions.

Build and test

  • npm run dev: run the server from TypeScript.
  • npm run build:core: compile the TypeScript server.
  • npm run automation:sync: sync the Unreal plugin into a target project.
  • npm run test:unit: run Vitest unit tests without Unreal.
  • npm run test:smoke: run the offline smoke path using mock connection mode.
  • npm test: run the MCP integration suite. This requires Unreal Editor with the bridge plugin available.
  • npm run test:all: run the integration entrypoints; treat this as Unreal-dependent unless you intentionally configured mock coverage.

Read the full file on GitHub · 53 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 53 lines · 997 tokens per session scan A 3aa4c408ebc3

Subscribe to this mod's changes

mcp-server-unreal-engine copilot-instructions.md is an instructions file published in the GitHub repository andrewkorot/mcp-server-unreal-engine (1 stars, last pushed 6mo ago), licensed MIT. It adds 997 tokens to every session, about $0.0040 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories