agentmods.dev

obsidian-agent-client: Instructions file for GitHub Copilot

.github/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

Written for GitHub Copilot: a Copilot instructions file.

This is RAIT-09/obsidian-agent-client's own configuration. It tells GitHub Copilot how to work on obsidian-agent-client itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything obsidian-agent-client configures →

not rated 2.5krepo +7 9d ago A scan 712 tokens original Apache-2.0
View source ↗ RAIT-09/obsidian-agent-client rait-09.github.io
About the project

obsidian-agent-client is an Obsidian plugin that embeds AI agents supporting the Agent Client Protocol into an Obsidian vault, allowing them to read and edit notes and work with project directories. It is for people who want to use agents such as Claude Code, Codex, or Gemini CLI inside Obsidian. The catalogue entries configure agent sessions, permissions, commands, and related workflows.

RAIT-09/obsidian-agent-client · 2,457 stars · on GitHub · rait-09.github.io

Reuse

Borrowing it

Nothing to install: this file belongs to RAIT-09/obsidian-agent-client. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/RAIT-09/obsidian-agent-client/master/.github/copilot-instructions.md
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/github.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/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.

agentmods 80×15 button for obsidian-agent-client copilot-instructions.md

Your own site · 80×15
<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="Reviewed on agentmods" width="80" 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. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00712 $0.00712
Opus 5.5 $0.00285 $0.00285
Sonnet 5.5 $0.00142 $0.00142
Haiku 4.5 $0.00071 $0.00071

Measured 1mo ago against content hash 638f6d6ea8dd, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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. 1mo 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,457 stars, last pushed 9d ago), licensed Apache-2.0. It adds 712 tokens to every session, about $0.0028 per session on Opus 5.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.

Building agentsClaude Codeagent-client-protocolcodexgemini-cliobsidian-mdobsidian-plugin
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 · 9,715 tokens

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.

vercel/next.js · 7,581 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

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.

deepseek-ai/deepseek-harness · 4,261 tokens

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

microsoft/vscode · 2,731 tokens