wiki AGENTS.md

Repository guidance for AI coding agents working on plasma-wiki, a standalone plugin that provides a wiki feature. It covers communication rules, project structure, setup, development, and checks.

In plain words
What is it for?
Use it when setting up or changing the wiki plugin, running its Python test suite, or working on its command-line, core, skill, utility, and asset code.
Why use it?
It tells agents how the project is organised and how to handle questions, code changes, testing, formatting, and pre-commit checks consistently.

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/plasma-ai/wiki/agents-md
Clone the repo
git clone --depth 1 https://github.com/plasma-ai/wiki

Made for: Codex, OpenCode.

Per session 4,450 This file is loaded in full into every session.
When invoked 4,450 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.04450 $0.04450
Opus 5 $0.02225 $0.02225
Sonnet 5 $0.00890 $0.00890
Haiku 4.5 $0.00445 $0.00445

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

Security

Grade A, and why

wiki 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 · 381 lines

How it starts

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

AGENTS

This file provides guidance to coding agents (Claude Code, Codex) when working with code in this repository. If you are not Claude Code (which already reads parent directories), also check the parent directory for AGENTS.md.

Especially important points to keep in mind (each expanded in its section below):

  • Questions are not edit requests. When a message asks a question without explicitly requesting a change, answer and stop (Communication).
  • Write clear and concise English. Write clear, concise, plain English which can be quickly and easily parsed by the user - answer questions directly in short form unless elaboration is requested (Writing Style).
  • Seek the best solution, not agreement. When you think the user is wrong, don't be afraid to say so — the right answer matters more than the path of least resistance (Pushing Back).

Overview

plasma-wiki is a standalone plugin providing the wiki skill.

The wiki/ Python package is organized into cli/ (typer app), core/ (business logic), skills/ (the plugin skill), util/ (shared utilities), and _assets/ (wiki config templates and the git merge driver), with the pytest suite in tests/.

A wiki is a folder tree of markdown pages indexed at every level by _index.md files, with .wiki/settings.json declaring the root. The tool owns the generated surfaces — wiki update regenerates index link blocks, frontmatter, and path-derived names from the filesystem, and wiki lint checks structure — while authored content lives below the *** delimiter. The _assets/ git merge driver auto-resolves the generated region of _index.md merges, so parallel edits conflict only on authored prose; wiki config installs the Obsidian integration.

core/ decomposes into wiki.py (the Wiki engine class), format.py (functions over the on-disk page format), event.py (the payload-only Event base), _obsidian.py (the internal Obsidian integration), and _search.py (the internal SQLite FTS5 index). Engine diagnostics are typed notice events: each kind has an on_<kind> hook delegating to the on_notice funnel, which logs event.description through the stdlib Wiki.logger; hosts intercept by overriding hooks (the CLI swaps on_notice per instance to capture and condense narration).

Read the full file on GitHub · 381 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 · 381 lines · 4,450 tokens per session scan A 20d689949c18

Subscribe to this mod's changes

wiki AGENTS.md is an instructions file published in the GitHub repository plasma-ai/wiki (81 stars, last pushed 4d ago), licensed Apache-2.0. It adds 4,450 tokens to every session, about $0.0222 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.

Related

Other instructions, from other repositories

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

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

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