OpenCode Obsidian is an Obsidian desktop plugin that embeds the OpenCode AI assistant in a vault's sidebar. It helps users summarize notes, refine writing, explore their knowledge base, and create structured outlines. The catalogue add-ons support workflows for this plugin and its OpenCode integration.
Borrowing it
Nothing to install: this file belongs to mtymek/opencode-obsidian. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/mtymek/opencode-obsidian/main/AGENTS.mdgit clone --depth 1 https://github.com/mtymek/opencode-obsidianWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/instructions/mtymek/opencode-obsidian/agents-md)<a href="https://agentmods.dev/instructions/mtymek/opencode-obsidian/agents-md"><img src="https://agentmods.dev/badge/instructions/mtymek/opencode-obsidian/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/mtymek/opencode-obsidian/agents-md"><img src="https://agentmods.dev/badge/instructions/mtymek/opencode-obsidian/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00752 | $0.00752 |
| Opus 5.5 | $0.00301 | $0.00301 |
| Sonnet 5.5 | $0.00150 | $0.00150 |
| Haiku 4.5 | $0.00075 | $0.00075 |
Grade A, and why
opencode-obsidian AGENTS.md scanned grade A with 1 finding 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 2mo 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.
Runs shell commandslowCapability
Expected in a hook, worth knowing in a rule or an instructions file.
- `child_process.spawn()` for server process How it starts
The opening of the file, as written. The whole thing — 93 lines — stays where its author put it; the contents beside it link to each section on GitHub.
AGENTS.md - Obsidian OpenCode Plugin
Guidelines for AI coding agents working on the obsidian-opencode plugin.
Project Overview
Obsidian plugin that embeds the OpenCode AI assistant via an iframe. Spawns a local server process and displays its web UI in the Obsidian sidebar.
Tech Stack: TypeScript, Obsidian Plugin API, esbuild, Node.js child processes
Build Commands
bun install # Install dependencies
bun run build # Production (type-check + bundle)
Output: main.js (CommonJS bundle)
Project Structure
src/
├── main.ts # Plugin entry, extends Plugin
├── types.ts # Types and constants
├── OpenCodeView.ts # Sidebar view (ItemView) with iframe
├── ProcessManager.ts # Server process lifecycle
└── SettingsTab.ts # Settings UI (PluginSettingTab)
Coding guidelines
Naming Conventions
| Type | Convention | Example |
|---|---|---|
| Classes | PascalCase | OpenCodePlugin, ProcessManager |
| Interfaces/Types | PascalCase | OpenCodeSettings, ProcessState |
| Constants | UPPER_CASE or camelCase | DEFAULT_SETTINGS, OPENCODE_VIEW_TYPE |
| Variables/functions | camelCase | getVaultPath, startServer |
| Private members | camelCase (no prefix) | private processManager |
| Files | PascalCase (classes), lowercase (entry) | ProcessManager.ts, main.ts |
TypeScript Patterns
strictNullChecksenabled - handle null/undefined- Union types for state:
"stopped" | "starting" | "running" | "error" async/awaitover Promises- Explicit return types on public methods
getProcessState(): ProcessState {
return this.processManager?.getState() ?? "stopped";
}
Obsidian API Patterns
- Extend
Pluginwithonload()/onunload()lifecycle - Extend
ItemViewfor views:getViewType(),onOpen(),onClose() - Extend
PluginSettingTabfor settings:display() - DOM helpers:
createEl(),createDiv(),setIcon() - Register in
onload(), clean up inonunload()
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.
- 2mo ago First seen · 93 lines · 752 tokens per session scan A ea1369441547
opencode-obsidian AGENTS.md is an instructions file published in the GitHub repository mtymek/opencode-obsidian (1,156 stars, last pushed 5mo ago), licensed MIT. It adds 752 tokens to every session, about $0.0030 per session on Opus 5.5. A static security scan graded it A with 1 finding (runs shell commands). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.
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).
next.js AGENTS.md
AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
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.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).
deepseek-harness AGENTS.md
AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.