zhin: Instructions file for GitHub Copilot

.github/instructions/zhin-plugin.instructions.md

zhin zhin-plugin.instructions.md is an instructions file for GitHub Copilot from zhinjs/zhin. It costs 1,745 tokens per session, scanned A, original, MIT.

A set of coding instructions for creating Zhin.js plugins, including their package files, entry point, imports, types, and convention-based folders. Zhin.js is a TypeScript framework for building bots that communicate across messaging channels.

In plain words
What is it for?
It is for implementing plugin commands, adapters, components, middleware, handlers, pages, tools, agents, and other runtime features.
Why use it?
It gives developers the repository’s expected rules in one place, reducing mistakes in plugin structure, dependency setup, and feature registration.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is zhinjs/zhin's own configuration. It tells GitHub Copilot how to work on zhin 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 zhin configures →

Reuse

Borrowing it

Nothing to install: this file belongs to zhinjs/zhin. 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/zhinjs/zhin/main/.github/instructions/zhin-plugin.instructions.md
Clone the repo
git clone --depth 1 https://github.com/zhinjs/zhin

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 zhin zhin-plugin.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/zhinjs/zhin/zhin-plugin/github.svg)](https://agentmods.dev/instructions/zhinjs/zhin/zhin-plugin)
Your own site
<a href="https://agentmods.dev/instructions/zhinjs/zhin/zhin-plugin"><img src="https://agentmods.dev/badge/instructions/zhinjs/zhin/zhin-plugin/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 zhin zhin-plugin.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/zhinjs/zhin/zhin-plugin"><img src="https://agentmods.dev/badge/instructions/zhinjs/zhin/zhin-plugin.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,745 This file is loaded in full into every session.
When invoked 1,745 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.01745 $0.01745
Opus 5.5 $0.00698 $0.00698
Sonnet 5.5 $0.00349 $0.00349
Haiku 4.5 $0.00175 $0.00175

Measured 16d ago against content hash f3e6c8192a9e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

zhin zhin-plugin.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 16d 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.

.github/instructions/zhin-plugin.instructions.md · 135 lines

How it starts

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

Zhin Plugin Runtime authoring

Package contract

  • Every Plugin is an npm package with package.json#zhin, plugin.ts and optional schema.json.
  • plugin.ts default-exports definePlugin() from zhin.js (Feature package authors may import from @zhin.js/plugin-runtime directly); it owns lifecycle and Resources, not capability registration.
  • Child packages live one level below plugins/*. Logical ancestry comes from zhin.plugins, not nested directories.
  • Feature providers are explicit zhin.features mounts. Root apps that depend on zhin.js inherit Stable Features via platformFeatures — they do not need separate @zhin.js/command / @zhin.js/middleware / @zhin.js/handler / @zhin.js/adapter / @zhin.js/component unless a child peer requires a directly resolvable shared provider. This inheritance is root-only: child plugins must declare each Feature they use in zhin.features. Shared providers such as Command belong in optional peerDependencies, supplied by the host as a direct dependency so child resolution reaches the same physical package. Do not install a separate provider copy inside a mounted child; npm optional peers do not make the runtime Feature optional. See the first-plugin tutorial for both mount modes.

Convention directories

adapters/<name>/index.ts              defineAdapter()      // import from zhin.js/adapter
commands/**/index.ts                  defineCommand()      // directory path is the route
components/<name>/index.ts            defineComponent()    // import from zhin.js/component
middlewares/<name>/index.ts           defineMiddleware()   // import from zhin.js/middleware
handlers/<name>/index.ts              defineHandler()      // explicit event supports dotted runtime names
tools/<name>/index.ts                 defineAgentTool()
hooks/<name>/index.ts                 defineHook()         // import from zhin.js/agent
skills/<name>/SKILL.md                Markdown Skill SSOT
skills/<name>/tools/<name>/index.ts   Skill-private defineAgentTool()
agents/<name>/agent.json              Agent metadata SSOT
agents/<name>/tools/<name>/index.ts   Agent-private defineAgentTool()
agents/<name>/skills/<name>/SKILL.md  Agent-private Skill SSOT
agents/<name>/skills/<name>/tools/<name>/index.ts
                                      Agent-Skill-private defineAgentTool()
mcps/<name>/index.ts                  defineMcp()
schedules/<name>/index.ts             defineSchedule()
pages/<name>/index.tsx                definePage()
pages/{nav,footer}/index.tsx          layout overrides

Read the full file on GitHub · 135 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. 16d ago Changed · +12 lines · +234 tokens per session f3e6c8192a9e
  2. 18d ago Changed · +10 lines · +278 tokens per session c54ab8421618
  3. 1mo ago Changed · +11 lines · +171 tokens per session eaa212b77380
  4. 1mo ago Changed · +3 lines · +44 tokens per session b8f2f48300f9
  5. 2mo ago First seen · 99 lines · 1,018 tokens per session scan A 465b09ed7ad0

Subscribe to this mod's changes

zhin zhin-plugin.instructions.md is an instructions file published in the GitHub repository zhinjs/zhin (136 stars, last pushed today), licensed MIT. It adds 1,745 tokens to every session, about $0.0070 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.

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,461 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

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

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