unreal-mcp: Instructions file for GitHub Copilot

.github/copilot-instructions.md

unreal-mcp copilot-instructions.md is an instructions file for GitHub Copilot from Flux-Point-Studios/unreal-mcp. It costs 609 tokens per session, scanned A, original, MIT.

Instructions for an MCP bridge that connects a TypeScript server with an Unreal Engine editor plugin, allowing an agent to automate parts of Unreal projects.

In plain words
What is it for?
Use them to develop, build, synchronize, and configure the bridge and Unreal plugin, including its WebSocket connection and offline mode.
Why use it?
They document constraints that help keep communication working, such as sending only JSON through standard output and using the expected local connection ports.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is Flux-Point-Studios/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 Flux-Point-Studios/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/Flux-Point-Studios/unreal-mcp/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/Flux-Point-Studios/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/flux-point-studios/unreal-mcp/copilot-instructions.svg)](https://agentmods.dev/instructions/flux-point-studios/unreal-mcp/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/flux-point-studios/unreal-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/flux-point-studios/unreal-mcp/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 609 This file is loaded in full into every session.
When invoked 609 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.00609 $0.00609
Opus 5 $0.00304 $0.00304
Sonnet 5 $0.00122 $0.00122
Haiku 4.5 $0.00061 $0.00061

Measured 8d ago against content hash f2a29d10c557, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, 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 8d 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 · 35 lines

How it starts

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

Copilot instructions for Unreal MCP

Big picture

  • Dual-process system: TypeScript MCP server in src/ + Unreal Editor plugin in plugins/McpAutomationBridge/.

Non-obvious constraints (don’t break MCP I/O)

  • Keep stdout JSON-only: runtime logs must go through Logger (see routeStdoutLogsToStderr() in src/index.ts). Avoid console.log in runtime code.
  • .env loading is silenced to protect stdout (see src/config.ts).

Key dev commands (from package.json)

  • Dev: npm run dev (ts-node-esm)
  • Build: npm run build:core
  • Plugin sync: npm run automation:sync

Connection + ports

  • The UE plugin listens by default on 127.0.0.1 ports 8090,8091 (see ListenPorts in plugins/.../McpAutomationBridgeSettings.cpp).
  • The TS bridge connects as a WebSocket client; override with env like MCP_AUTOMATION_CLIENT_PORT or MCP_AUTOMATION_WS_PORTS (see src/automation/bridge.ts).
  • Offline mode: set MOCK_UNREAL_CONNECTION=true to force UnrealBridge.tryConnect() to succeed.

Tooling conventions (TS)

  • Tool schemas live in src/tools/consolidated-tool-definitions.ts (action enums + input/output schemas). Output schemas are registered at startup in src/index.ts and validated by AJV in src/utils/response-validator.ts.
  • Tool routing is via toolRegistry.register() in src/tools/consolidated-tool-handlers.ts and domain logic in src/tools/handlers/*-handlers.ts.
  • Always call Unreal through executeAutomationRequest() (src/tools/handlers/common-handlers.ts) rather than raw WS.

Safety + normalization

  • Console commands are safety-filtered by src/utils/command-validator.ts; don’t bypass it.
  • UE calls are throttled/retried via src/utils/unreal-command-queue.ts.
  • Prefer /Game/... paths; some layers normalize /Content/Game (e.g. src/resources/assets.ts, src/tools/assets.ts, and plugin helpers in plugins/.../McpAutomationBridgeHelpers.h).

Adding a new action end-to-end

  1. TS: extend the tool’s action enum + schemas in src/tools/consolidated-tool-definitions.ts.
  2. TS: route the action in src/tools/consolidated-tool-handlers.ts (or the appropriate src/tools/handlers/*-handlers.ts).
  3. C++: implement the action in an appropriate plugins/.../*Handlers.cpp and register it in UMcpAutomationBridgeSubsystem::InitializeHandlers().
  4. Tests: add/extend a case in tests/integration.mjs.

Read the full file on GitHub · 35 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. 8d ago First seen · 35 lines · 609 tokens per session scan A f2a29d10c557

Subscribe to this mod's changes

unreal-mcp copilot-instructions.md is an instructions file published in the GitHub repository Flux-Point-Studios/unreal-mcp (8 stars, last pushed 4mo ago), licensed MIT. It adds 609 tokens to every session, about $0.0030 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-31.

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,153 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

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

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