Unreal_mcp: Instructions file for GitHub Copilot

.github/copilot-instructions.md

Unreal_mcp copilot-instructions.md is an instructions file for GitHub Copilot from ChiR24/Unreal_mcp. It costs 1,026 tokens per session, scanned A, original, MIT.

Project instructions for coding agents working with an Unreal Engine MCP integration. Unreal Engine is software for building games and other real-time 3D applications; MCP connects an agent to tools in that environment.

In plain words
What is it for?
Use them when changing the TypeScript MCP server, its Unreal Editor bridge, tool routing, automation flow, tests, or Unreal asset paths.
Why use it?
They explain the project architecture and critical rules, reducing the risk of broken communication, invalid asset paths, or unsafe Unreal Engine changes.

Instructions file for GitHub Copilot

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

This is ChiR24/Unreal_mcp's own configuration. It tells GitHub Copilot how to work on Unreal_mcp 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 Unreal_mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to ChiR24/Unreal_mcp. 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/ChiR24/Unreal_mcp/dev/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/ChiR24/Unreal_mcp

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 Unreal_mcp copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/chir24/unreal_mcp/copilot-instructions.svg)](https://agentmods.dev/instructions/chir24/unreal_mcp/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/chir24/unreal_mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/chir24/unreal_mcp/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,026 This file is loaded in full into every session.
When invoked 1,026 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.01026 $0.01026
Opus 5 $0.00513 $0.00513
Sonnet 5 $0.00205 $0.00205
Haiku 4.5 $0.00103 $0.00103

Measured 6d ago against content hash 0aa62f9df570, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

Unreal_mcp 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 6d 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/server/server-factory.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 wrappers under plugins/McpAutomationBridge/Source/McpAutomationBridge/Private/Safety/.
  • 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. 6d ago First seen · 53 lines · 1,026 tokens per session scan A 0aa62f9df570

Subscribe to this mod's changes

Unreal_mcp copilot-instructions.md is an instructions file published in the GitHub repository ChiR24/Unreal_mcp (856 stars, last pushed 2d ago), licensed MIT. It adds 1,026 tokens to every session, about $0.0051 per session on Opus 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-30.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens