uxc AGENTS.md

A set of project instructions for holon-run/uxc that explains its Rust code layout, development commands, coding conventions, tests, and documentation.

In plain words
What is it for?
Use it when building, testing, formatting, linting, or documenting the project. It also describes the command-line app, protocol adapters, documentation, and continuous-integration files.
Why use it?
It gives a coding agent the repository rules in one place, reducing guesswork about where code belongs and how changes should be checked.

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/holon-run/uxc/agents-md
Clone the repo
git clone --depth 1 https://github.com/holon-run/uxc

Made for: Codex, OpenCode.

Per session 891 This file is loaded in full into every session.
When invoked 891 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.00891 $0.00891
Opus 5 $0.00445 $0.00445
Sonnet 5 $0.00178 $0.00178
Haiku 4.5 $0.00089 $0.00089

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

Security

Grade A, and why

uxc 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 · 55 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

  • src/main.rs: CLI entrypoint, argument parsing, and command routing.
  • src/lib.rs: public exports and shared crate surface.
  • src/adapters/: protocol implementations (openapi, graphql, grpc, mcp).
  • src/auth/, src/cache/, src/error.rs, src/output.rs, src/protocol.rs: cross-cutting modules.
  • tests/: integration and regression tests (for example, auth_integration_test.rs, cli_help_regression_test.rs).
  • docs/site/: public documentation site content served via mdorigin.
  • docs/: internal notes, release/maintenance docs, and architectural decisions.
  • .github/workflows/: CI, lint, build matrix, E2E smoke checks, and docs-site deployment.

Build, Test, and Development Commands

  • make build or cargo build --release: build optimized CLI binary.
  • make run or cargo run -- <args>: run locally.
  • make test or cargo test: run test suite.
  • make check: quick validation (cargo check + cargo clippy).
  • make fmt or cargo fmt -- --check: format/check formatting.
  • cargo clippy -- -D warnings: enforce lint cleanliness before PR.
  • npm run docs:dev: preview the docs site locally.
  • npm run docs:index: regenerate directory indexes for docs/site/.
  • npm run docs:build: build the Cloudflare docs-site bundle.

Coding Style & Naming Conventions

  • Use Rust 2021 conventions and rustfmt defaults (4-space indentation, no manual alignment tricks).
  • Naming: files/modules in snake_case; types/traits in CamelCase; constants in SCREAMING_SNAKE_CASE.
  • Keep CLI behavior predictable: JSON output envelope is the default contract, text mode is opt-in (--text).
  • Prefer small, focused modules; add protocol-specific logic under src/adapters/<protocol>.rs.

Documentation Guidelines

  • Put public product documentation in docs/site/. Do not add new public-facing docs under top-level docs/.
  • Keep docs/ for internal decision notes, release/maintenance workflows, and architectural records.
  • Treat README.md and README.zh-CN.md as GitHub landing pages; prefer linking user-facing docs to https://uxc.holon.run.
  • Treat skills/README.md and https://uxc.holon.run/skills/ as the browsable skills catalog.
  • Keep docs/operations/skills.md as the skills publish and maintenance log, not as the primary skills directory.
  • When changing docs/site/, run npm run docs:index and npm run docs:build before pushing.

Read the full file on GitHub · 55 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 · 55 lines · 891 tokens per session scan A 51e3479e1700

Subscribe to this mod's changes

uxc AGENTS.md is an instructions file published in the GitHub repository holon-run/uxc (113 stars, last pushed 25d ago), licensed MIT. It adds 891 tokens to every session, about $0.0045 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.