obsidian-agent-client copilot-instructions.md

obsidian-agent-client copilot-instructions.md is an instructions file for GitHub Copilot from RAIT-09/obsidian-agent-client. It costs 712 tokens per session, scanned A, original, Apache-2.0.

Project-specific guidance for GitHub Copilot when working on an Obsidian desktop plugin that connects to external coding agents. It describes the code layout, architecture rules, and how sessions and streamed messages work.

In plain words
What is it for?
Use it to locate chat, session, message, protocol, and domain code, and to follow rules for adding features and handling agent updates.
Why use it?
It reduces guesswork about where to make changes and helps keep new code consistent with the plugin’s existing design.

Instructions file for GitHub Copilot

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/rait-09/obsidian-agent-client/copilot-instructions
Clone the repo
git clone --depth 1 https://github.com/RAIT-09/obsidian-agent-client

Made for: GitHub Copilot.

Wrote 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.

agentmods badge for obsidian-agent-client copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/rait-09/obsidian-agent-client/copilot-instructions.svg)](https://agentmods.dev/instructions/rait-09/obsidian-agent-client/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/rait-09/obsidian-agent-client/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/rait-09/obsidian-agent-client/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 712 This file is loaded in full into every session.
When invoked 712 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.00712 $0.00712
Opus 5 $0.00356 $0.00356
Sonnet 5 $0.00142 $0.00142
Haiku 4.5 $0.00071 $0.00071

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

Security

Grade A, and why

obsidian-agent-client copilot-instructions.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 4d 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.github/copilot-instructions.md · 46 lines

How it starts

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

GitHub Copilot Instructions (obsidian-agent-client)

Big picture

  • Obsidian desktop plugin (React 19 + TypeScript) that chats with external coding agents via Agent Client Protocol (ACP).
  • Uses a React Hooks Architecture: hooks own state/logic, components render, adapters integrate external systems, domain is pure types.

Key directories / “where to change things”

  • UI composition + adapter instantiation: src/components/chat/ChatView.tsx (creates adapters via useMemo, composes hooks).
  • Session lifecycle + agent switching: src/hooks/useAgentSession.ts.
  • Message state + streaming updates: src/hooks/useChat.ts.
  • ACP process + JSON-RPC wiring: src/adapters/acp/acp.adapter.ts.
  • Pure message prep/sending (mentions, auto-mention, WSL path conversion): src/shared/message-service.ts.
  • Domain contracts only (no deps): src/domain/models/*, src/domain/ports/*.

Architectural rules (project-specific)

  • Keep src/domain/** dependency-free: no obsidian imports, no @agentclientprotocol/sdk imports.
  • Add new behavior as hooks under src/hooks/ and compose them in ChatView.tsx (avoid introducing ViewModel/UseCase classes).
  • Put non-React business logic in src/shared/ as pure functions (see message-service.ts).
  • Adapters implement ports and isolate protocol/platform churn (ACP changes should mostly stay in src/adapters/acp/).

SessionUpdate / tool-call update flow (critical)

  • Use the unified pipeline: AcpAdapter.onSessionUpdate(...)useChat.handleSessionUpdate(...).
  • Tool calls must be updated via useChat.upsertToolCall(...) using functional setMessages((prev) => ...) to avoid race conditions from streaming tool_call_update events.
  • When merging tool-call content, preserve existing values when updates are undefined and treat diffs as replace-all (see mergeToolCallContent in useChat.ts).

Obsidian & platform constraints

  • Desktop-only: ChatView throws when !Platform.isDesktopApp.
  • Use Obsidian Platform.isWin/isMacOS/isLinux helpers (avoid process.platform).
  • No innerHTML/outerHTML; use Obsidian element helpers (createEl/createDiv/createSpan).
  • Don't detach leaves in onunload.
  • Keep styling in styles.css (avoid JS style manipulation).

Read the full file on GitHub · 46 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. 4d ago First seen · 46 lines · 712 tokens per session scan A 638f6d6ea8dd

Subscribe to this mod's changes

obsidian-agent-client copilot-instructions.md is an instructions file published in the GitHub repository RAIT-09/obsidian-agent-client (2,388 stars, last pushed today), licensed Apache-2.0. It adds 712 tokens to every session, about $0.0036 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

entwurf AGENTS.md

Instructions for junghan0611/entwurf, covering agents.md — maintainer guidelines for entwurf, north star — one forged screwdriver, architecture, hard rules and acp plugin boundary.

junghan0611/entwurf · 7,395 tokens

obsidian-transcriber AGENTS.md

Instructions for dsebastien/obsidian-transcriber, covering project documentation, documentation surfaces, project overview, agent workflow and session-start checklist.

dsebastien/obsidian-transcriber · 7,994 tokens

claude-sessions CLAUDE.md

Instructions for gapmiss/claude-sessions, covering claude sessions — obsidian plugin, development, file structure, code exploration (cymbal) and conventions.

gapmiss/claude-sessions · 1,498 tokens

mcp-obsidian-via-rest CLAUDE.md

Instructions for OleksandrKucherenko/mcp-obsidian-via-rest, covering claude.md, project overview, development commands, building and running and install dependencies.

OleksandrKucherenko/mcp-obsidian-via-rest · 3,822 tokens

obsidian-transcriber CLAUDE.md

Instructions for dsebastien/obsidian-transcriber, a project described as: Transcriber converts images in your Obsidian vault to Markdown using Ollama vision models running locally on your machine.

dsebastien/obsidian-transcriber · 7 tokens

mcp-obsidian-via-rest AGENTS.md

Instructions for OleksandrKucherenko/mcp-obsidian-via-rest, a project described as: MCP Server connected to Obsidian Vault with Local REST API. (re-write it completely with BUN to make it faster and more lightweight).

OleksandrKucherenko/mcp-obsidian-via-rest · 6 tokens