docfs AGENTS.md

Repository instructions for docfs, a read-only local file server that lets agents inspect approved folders.

In plain words
What is it for?
Use them when working on docfs, including searching files, running checks, building, testing, and keeping paths within configured roots.
Why use it?
They give agents the project's layout, commands, coding style, tests, and safe file-inspection rules.

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

Made for: Codex, OpenCode.

Per session 457 This file is loaded in full into every session.
When invoked 457 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.00457 $0.00457
Opus 5 $0.00229 $0.00229
Sonnet 5 $0.00091 $0.00091
Haiku 4.5 $0.00046 $0.00046

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

Security

Grade A, and why

docfs 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 · 57 lines

What it actually says

Repository Guidelines

DocFS is a read-only filesystem MCP server with multiple root support, .gitignore filtering, and an in-memory LRU cache for file metadata. Compared to a generic filesystem MCP server, it offers only inspection tools and strictly validates paths against the configured roots.

MCP Tools for Agents

  • list_files: list files and directories
  • search_files: search text in files
  • read_files: read file contents
  • dir_tree: list directory tree

Use list_filessearch_filesread_filesdir_tree to explore the repo. Keep paths within allowed --root directories.

Project Structure

  • src/index.ts – server entry
  • src/tools/ – tool implementations
  • src/utils/ – filesystem helpers
  • src/types/ – shared types
  • src/__tests__/ – Jest tests

Commands

  • pnpm install – install dependencies
  • pnpm dev – run server in TS
  • pnpm build – compile to dist/
  • pnpm start – run compiled server
  • pnpm lint / pnpm lint:fix
  • pnpm format / pnpm format:check
  • pnpm test
  • pnpm typecheck

Style

  • TypeScript (strict ESM), Node >= 18
  • Prettier: 2 spaces, 100 columns, single quotes, semicolons
  • ESLint with typescript-eslint; prefer named exports and camelCase.ts

Testing

  • Jest with ts-jest
  • Tests in src/__tests__/ or *.test.ts
  • Target ≥ 80% coverage

Commit & PR Guidelines

  • Conventional Commits (e.g., docs: update readme)
  • Ensure pnpm build, pnpm lint, and pnpm test pass before committing
  • PRs should include clear descriptions and usage examples

Security

  • Only files under specified --root directories are accessible
  • read_files enforces file size limits; avoid large binaries
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 · 57 lines · 457 tokens per session scan A 5f72efbda2e0

Subscribe to this mod's changes

docfs AGENTS.md is an instructions file published in the GitHub repository feli0x/docfs (0 stars, last pushed 12mo ago), licensed MIT. It adds 457 tokens to every session, about $0.0023 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.