umbriel AGENTS.md

A repository instruction file describing how to work on Umbriel, a TypeScript package for controlling and testing Windows desktop applications through their accessibility information.

In plain words
What is it for?
Use it when modifying Umbriel code, especially its Windows automation, TypeScript, Bun, and native-interface integrations.
Why use it?
It gives coding agents project-specific rules about the architecture, dependencies, repository layout, and commands. This reduces the chance of changes that conflict with the project's design.

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/obscuritysrl/umbriel/agents-md
Clone the repo
git clone --depth 1 https://github.com/ObscuritySRL/umbriel

Made for: Codex, OpenCode.

Per session 3,391 This file is loaded in full into every session.
When invoked 3,391 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.03391 $0.03391
Opus 5 $0.01695 $0.01695
Sonnet 5 $0.00678 $0.00678
Haiku 4.5 $0.00339 $0.00339

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

Security

Grade A, and why

umbriel 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 · 172 lines

How it starts

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

AGENTS

Rules for working in umbriel — Playwright for the Windows desktop, from Bun. A single, zero-native-dependency package that drives and tests native Windows GUIs through the UI Automation accessibility tree (find by name, invoke, type, assert), plus synthetic input, full-screen capture + image matching, native-window introspection (Spy++-style), an LLM computer-use adapter, OCR, and a stdio MCP server. No node-gyp, no prebuilt binaries, no sidecar process. Follow these rules exactly.

umbriel is pure TypeScript over bun:ffi. It does not bind any DLL itself — it consumes the published @bun-win32/* FFI binding packages (core, user32, oleacc, combase, kernel32, gdi32, shell32, shcore, oleaut32, advapi32, dwmapi, d3d11) as ordinary pinned npm dependencies, and composes them into a high-level desktop-automation API. (One exception: a Win32 symbol/DLL that no installed @bun-win32/* binding covers may be hand-rolled here as a last resort — see the FFI Binding Rules — but every such case is logged in TODO.md for the owner to upstream into bun-win32.)

umbriel was extracted from the bun-win32 monorepo (formerly @bun-win32/uia + bun-uia) into its own standalone repo and unscoped npm package. The FFI layer it stands on still lives in @bun-win32/*; only the product is standalone.


Core Principles

  • Plan before implementing. Read and understand the problem, the existing code, and the surrounding context before writing anything. Do not guess at what code does — read it.
  • No fabrication — verify every claim. This drives a real OS through real accessibility and input APIs. Never guess a signature, HRESULT, pattern id, or nullability. Verify against the Microsoft Learn docs page and the upstream @bun-win32/* binding. Incorrect FFI usage segfaults; incorrect information is worse than none. If you do not know, say so.
  • Minimal, surgical diffs. Change only what the task requires. Do not "clean up," reformat, or refactor code you were not asked to touch.
  • No premature abstraction. No helpers, wrappers, or utilities unless explicitly requested. Keep the public facade thin.
  • Verify at every step. After every meaningful change, prove it works: run the file (bun run …), type-check (bunx tsc --noEmit), and run the relevant example/test. Do not pile changes on a broken state.
  • Safety is load-bearing. The MCP server exposes this machine to an LLM. Capability profiles, credential redaction, and the cursor-free input paths are security features — never weaken them to make a demo pass.

Read the full file on GitHub · 172 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 · 172 lines · 3,391 tokens per session scan A 12773f30230c

Subscribe to this mod's changes

umbriel AGENTS.md is an instructions file published in the GitHub repository ObscuritySRL/umbriel (2 stars, last pushed 18d ago), licensed MIT. It adds 3,391 tokens to every session, about $0.0170 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

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

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

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

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

next.js 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