agentmods.dev

copilot-kit: Instructions file for GitHub Copilot

.github/instructions/documentation.instructions.md

copilot-kit documentation.instructions.md is an instructions file for GitHub Copilot from ivanshtokov/copilot-kit. It costs 294 tokens per session, scanned A, original, MIT.

A set of rules for writing project documentation, including README files, setup instructions, API references, examples, and code comments. Documentation explains how software works and how other developers use it.

In plain words
What is it for?
Use it when creating or reviewing README files, installation guides, configuration notes, API documentation, contribution instructions, and comments for public code.
Why use it?
It gives projects a consistent structure and makes setup and maintenance easier for people who did not write the code. It also helps keep public interfaces and examples understandable.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

not rated 4repo 9mo ago A scan 294 tokens original MIT
View source ↗ ivanshtokov/copilot-kit
Reuse

Borrowing it

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

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 copilot-kit documentation.instructions.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/ivanshtokov/copilot-kit/documentation"><img src="https://agentmods.dev/badge/instructions/ivanshtokov/copilot-kit/documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 294 This file is loaded in full into every session.
When invoked 294 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.00294 $0.00294
Opus 5.5 $0.00118 $0.00118
Sonnet 5.5 $0.00059 $0.00059
Haiku 4.5 $0.00029 $0.00029

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

Security

Grade A, and why

copilot-kit documentation.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 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.

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/documentation.instructions.md · 64 lines

What it actually says

Documentation Standards

🎯 Before Any Docs Work

READ: .github/skills/documentation-templates/SKILL.md

📋 README Structure

# Project Name

Brief description (1-2 sentences)

## Features
- Feature 1
- Feature 2

## Quick Start
\`\`\`bash
npm install
npm run dev
\`\`\`

## Documentation
- [Installation](docs/installation.md)
- [Configuration](docs/configuration.md)
- [API Reference](docs/api.md)

## Contributing
Guidelines for contributors

## License
MIT

✍️ Writing Style

  • Use active voice
  • Be concise and direct
  • Use code blocks for commands/code
  • Add examples for complex concepts
  • Use headings for structure (H2, H3)

📝 Code Comments

Type When to Use
// Comment Brief inline explanation
/** JSDoc */ Public API documentation
// TODO: Future improvements
// FIXME: Known issues

🔧 API Documentation

  • Document all public endpoints
  • Include request/response examples
  • Specify error codes and messages
  • Keep examples up-to-date with code
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. 2mo ago First seen · 64 lines · 294 tokens per session scan A f2db1f5f1e59

Subscribe to this mod's changes

copilot-kit documentation.instructions.md is an instructions file published in the GitHub repository ivanshtokov/copilot-kit (4 stars, last pushed 9mo ago), licensed MIT. It adds 294 tokens to every session, about $0.0012 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-31.

Writing and docs
Related

copilot-kit documentation.instructions.md compared with instructions from other repositories

copilot-kit documentation.instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
copilot-kit documentation.instructions.mdivanshtokov/copilot-kitInstructions file49mo agoMITA294GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode