unityctl AGENTS.md

Repository instructions for unityctl, a tool that controls or communicates with Unity editors, covering how to navigate the codebase and which folders own shared contracts, core logic, and platform-specific code.

In plain words
What is it for?
Use them when working on unityctl to follow the required reading order, understand folder responsibilities, and identify the shared .NET and core projects.
Why use it?
They help developers find the correct source-of-truth documents and place changes in the right part of the repository.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/jason-hub-star/unityctl/agents-md
Clone the repo
git clone --depth 1 https://github.com/Jason-hub-star/unityctl

Made for: Codex, OpenCode.

Per session 1,288 This file is loaded in full into every session.
When invoked 1,288 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 $0.01288 $0.01288
Opus 5 $0.00644 $0.00644
Sonnet 5 $0.00258 $0.00258
Haiku 4.5 $0.00129 $0.00129

Measured 3d ago against content hash 63680849878e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

unityctl AGENTS.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 3d 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.

AGENTS.md · 88 lines

How it starts

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

unityctl AGENTS Index

이 저장소의 Source-of-Truth 탐색 문서입니다. 폴더 책임, 파일 탐색 순서, 작업 규칙을 여기서 파악합니다.

Start Here

  1. AGENTS.md (Codex) 또는 CLAUDE.md (Claude) — 동일 정책 진입 문서
  2. docs/ref/architecture-mermaid.md
  3. docs/status/PROJECT-STATUS.md
  4. docs/ref/phase-roadmap.md

Mandatory Navigation Rule

  • 항상 루트 AGENTS.md를 먼저 읽은 후 파일 탐색을 시작한다.
  • src/ 하위 프로젝트 작업 시 해당 폴더의 구조를 먼저 파악한다.
  • 빠른 시스템 맥락은 docs/ref/architecture-mermaid.md를 먼저 읽는다.
  • 제품/계획 작업은 docs/status/PROJECT-STATUS.mddocs/ref/ 정식 문서를 먼저 읽는다.

Folder Responsibility Rule

src/Unityctl.Shared (netstandard2.1)

프로토콜 + 모델 + 상수. CLI/Core/Plugin 모두 참조하는 공유 계약.

  • Protocol/ — CommandRequest, CommandResponse, StatusCode, WellKnownCommands
  • Transport/ — ITransport, TransportCapability
  • Serialization/ — JsonContext (System.Text.Json Source Generator)
  • Models/ — UnityEditorInfo, BuildRequest, TestRequest
  • Constants.cs — 버전, 파이프명, 타임아웃

src/Unityctl.Core (net10.0)

비즈니스 로직. Transport, Discovery, Retry, Platform 추상화.

  • Transport/ — BatchTransport, IpcTransport, MessageFraming, CommandExecutor
  • Platform/ — IPlatformServices, Windows/Mac/Linux 구현
  • Discovery/ — UnityEditorDiscovery
  • Retry/ — RetryPolicy

src/Unityctl.Cli (net10.0)

얇은 CLI 셸. 모든 로직은 Core에 위임.

  • Commands/ — PingCommand, StatusCommand, BuildCommand, TestCommand, CheckCommand, EditorCommands, InitCommand, ToolsCommand
  • Output/ — ConsoleOutput, JsonOutput

src/Unityctl.Mcp (net10.0)

네이티브 MCP 서버. 얇은 도구 레이어에서 Core를 호출한다.

  • Tools/unityctl_query, unityctl_run, unityctl_schema, unityctl_status, unityctl_watch 등 top-level MCP 도구
  • Program.cs — stdio MCP 서버 부트스트랩

src/Unityctl.Plugin (Unity UPM)

Unity Editor 브릿지. dotnet build 불가 — Unity 내에서만 컴파일.

  • Editor/Ipc/ — IpcServer, IpcRequestRouter, PipeNameHelper, MessageFraming
  • Editor/Commands/ — CommandRegistry, PingHandler, StatusHandler, BuildHandler, TestHandler, TestResultHandler, CheckHandler, AsyncOperationRegistry
  • Editor/Bootstrap/ — UnityctlBootstrap (InitializeOnLoad)
  • Editor/BatchMode/ — UnityctlBatchEntry
  • Editor/Shared/ — Protocol 타입 소스 복사 (Newtonsoft 기반)

Read the full file on GitHub · 88 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. 3d ago First seen · 88 lines · 1,288 tokens per session scan A 63680849878e

Subscribe to this mod's changes

unityctl AGENTS.md is an instructions file published in the GitHub repository Jason-hub-star/unityctl (18 stars, last pushed 13d ago), licensed MIT. It adds 1,288 tokens to every session, about $0.0064 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.