docsgrep AGENTS.md

A project-instructions package containing AGENTS.md guidance for the docsgrep repository. AGENTS.md is a file that tells coding agents about commands, structure, conventions, and important project rules.

In plain words
What is it for?
Use it when modifying docsgrep to understand its TypeScript layout, build and test commands, tool modules, and required conventions.
Why use it?
It gives an agent the repository-specific context needed to work consistently and run the right checks.

Instructions file for CodexOpenCode

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/reasvyn/docsgrep/agents-md
Clone the repo
git clone --depth 1 https://github.com/reasvyn/docsgrep

Made for: Codex, OpenCode.

Per session 749 This file is loaded in full into every session.
When invoked 749 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.00749 $0.00749
Opus 5 $0.00375 $0.00375
Sonnet 5 $0.00150 $0.00150
Haiku 4.5 $0.00075 $0.00075

Measured yesterday against content hash 81b70cb702fc, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docsgrep AGENTS.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 yesterday.

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.

AGENTS.md · 59 lines

How it starts

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

AGENTS.md

Quick Commands

pnpm install        # install deps
pnpm build          # compile TypeScript (tsc) → build/
pnpm test           # vitest
pnpm test:coverage

Commands prefixed lint, audit, bugs, docs:check, docs:stale run docsgrep on itself (dogfooding). They require a prior pnpm build.

Repo Structure

Single-package TypeScript project (ESM).

  • src/index.ts — entry point (MCP server setup + plugin discovery, keep thin)
  • src/cli.ts — CLI argument parsing and display
  • src/core-tools.ts — class-based tools (AnalyzeCodeTool, AuditSecurityTool, CatchBugsTool)
  • src/tools/ — tool handlers; one module per logical group:
    • base.ts — BaseTool abstract class (semaphore, logging, credential masking)
    • registry.ts — ToolRegistry (imports from split modules, self-registers core tools)
    • doc-find.ts, doc-search.ts, doc-inspect.ts, doc-coverage.ts — documentation tools
    • doc-verify.ts, doc-sync.ts — verification and sync tools
    • help.ts, repo-analysis.ts, repo.ts — help, stack detection, clone
    • workspace.ts — workspace init and cache management
    • archetypes.ts, audit-ask.ts — pattern detection and interactive prompts
  • src/utils/ — shared utilities (file scanning, git, validation, workspace, cache, logging)
  • src/types/tools.ts — tool input interfaces
  • src/config/ — JSON config for limits, patterns, language defs
  • tests/ — Vitest test suites (tests/**/*.test.ts)
  • docs/ — project and tool documentation

Critical Conventions

  • ESM with .js extensions: all local imports MUST include .js (e.g., import { x } from "./utils.js").
  • Strict TypeScript: no implicit any. Use McpToolResponse for tool outputs.
  • BaseTool pattern: new tool handlers should extend BaseTool from tools/base.ts for logging, credential masking, and concurrency limiting.
  • Scanning: use FileScanner.findFiles for filesystem scanning. Scanning tools must support includePath/excludePath and respect .gitignore via getIgnorePatterns from utils/file.ts.
  • Validation: validate dirPath inputs with validateDirPath.
  • App metadata: use AppInfo from utils/app-info.ts, never hardcode version/name.

Read the full file on GitHub · 59 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. yesterday First seen · 59 lines · 749 tokens per session scan A 81b70cb702fc

Subscribe to this mod's changes

docsgrep AGENTS.md is an instructions file published in the GitHub repository reasvyn/docsgrep (0 stars, last pushed 1mo ago), licensed MIT. It adds 749 tokens to every session, about $0.0037 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-31.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

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 · 6,785 tokens

next.js 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,296 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 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,345 tokens