Nyamu AGENTS.md

A set of instructions for working with the Nyamu MCP server, which connects an AI coding agent to the Unity Editor for compiling projects and reporting errors.

In plain words
What is it for?
Making Unity project file changes, triggering compilation, retrieving compiler errors, and iterating until the errors are resolved.
Why use it?
It gives a defined edit–compile–debug process and explains which compilation check to run after creating, deleting, or editing files.

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/polyblank66/nyamu/agents-md
Clone the repo
git clone --depth 1 https://github.com/polyblank66/Nyamu

Made for: Codex, OpenCode.

Per session 2,927 This file is loaded in full into every session.
When invoked 2,927 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.02927 $0.02927
Opus 5 $0.01463 $0.01463
Sonnet 5 $0.00585 $0.00585
Haiku 4.5 $0.00293 $0.00293

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

Security

Grade A, and why

Nyamu 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 2d 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 · 207 lines

How it starts

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

About MCP

  • This project uses the Nyamu MCP server, which enables triggering compilations and retrieving compilation errors from the Unity Editor.
  • Iterate through the edit-compile-debug cycle until all errors are resolved.

Nyamu MCP Workflow Guidelines

File Operation Workflows

CRITICAL: Always call assets_refresh after file operations - it returns compilation error information:

  • Creating files: Write → assets_refresh(force=false) → Wait for MCP (response includes compilation errors)
  • Deleting files: Delete → assets_refresh(force=true) → Wait for MCP (response includes compilation errors)
  • Editing existing files: Edit → scripts_compile (no refresh needed)

Compilation Tools

  • assets_refresh - PRIMARY COMPILATION CHECK TOOL (params: force, default false)
    • Main command to check compilation status after any file operations
    • Returns compilation error information, showing last compilation status even if no new compilation occurred
    • Unified tool: asset refresh + compilation trigger + status check in one command
    • Use force=true when deleting files to prevent CS2001 errors
    • Use force=false when creating/editing files
    • No need to call scripts_compile_status separately - this tool provides all compilation information
  • scripts_compile - Direct C# compilation trigger (params: timeout, default 30s)
    • Use for editing existing files without structural changes (faster than assets_refresh)
  • scripts_compile_status - Check compilation status without triggering (no params)
    • Use only when you need status check without any file operations

Error Handling

  • Error -32603 "HTTP request failed": Expected during Unity recompilation/refresh
    • Wait 3-5 seconds and retry
    • This is normal behavior - Unity HTTP server is restarting
  • Always wait for MCP responsiveness after assets_refresh before calling other tools

Testing Tools

Available test execution tools:

  • tests_run_all - Run all tests (params: test_mode, timeout)
  • tests_run_single - Run specific test (params: test_name required, test_mode, timeout)
  • tests_run_regex - Run tests matching regex (params: test_filter_regex required, test_mode, timeout)
  • tests_run_status - Check test execution status (no params)
  • tests_run_cancel - Cancel running tests (params: test_run_guid optional)

Read the full file on GitHub · 207 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. 2d ago First seen · 207 lines · 2,927 tokens per session scan A 47c2784f2a58

Subscribe to this mod's changes

Nyamu AGENTS.md is an instructions file published in the GitHub repository polyblank66/Nyamu (15 stars, last pushed 8d ago), licensed MIT. It adds 2,927 tokens to every session, about $0.0146 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.