search-docs AGENTS.md

A repository guide for search-docs, a local-document search system that finds relevant text using vector search. Vector search compares the meaning of text, rather than only matching exact words.

In plain words
What is it for?
Use it when working on the search-docs codebase, its MCP or HTTP servers, document storage, indexing, embedding service, or related architecture.
Why use it?
It explains the project structure and operating model, so an agent can understand how the MCP server, document watcher, database, and embedding service fit together.

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

Made for: Codex, OpenCode.

Per session 2,512 This file is loaded in full into every session.
When invoked 2,512 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.02512 $0.02512
Opus 5 $0.01256 $0.01256
Sonnet 5 $0.00502 $0.00502
Haiku 4.5 $0.00251 $0.00251

Measured 2d ago against content hash a1fbed33b923, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

search-docs 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 2d 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.

AGENTS.md · 226 lines

How it starts

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

🐕️ search-docs - Claude Code用プロジェクトガイド

プロジェクト概要

search-docsは、ローカル文書のVector検索システムです。プロジェクト毎に起動される検索サーバと、複数のクライアント形式で構成されています。

アーキテクチャ

プロセス構成

MCP Server (stdio)
  ├─ in-process: SearchDocsServer (read-only)
  ├─ in-process: WatcherProcess (write, heartbeat調停)
  ├─ in-process: DBEngine
  └─ subprocess: Embedding Server (stateless, 共有可能)
           │
           ▼
       LanceDB (共有ストレージ)

詳細: docs/client-server-architecture.md

アーキテクチャ構成

search-docsは以下の構成で動作します:

  1. MCP Server (packages/mcp-server/)

    • Claude Code統合、stdio通信
    • SearchDocsServerをin-processで直接保持(HTTPデーモン不要)
    • SearchDocsServiceインターフェイス経由でサーバ機能を利用
  2. JSON-RPC Server (packages/server/src/bin/server.ts)

    • search-docs server start コマンドでHTTPサーバとしてexposeする用途
    • WatcherProcess内蔵、Heartbeat調停で複数インスタンス間を自動協調
    • MCPサーバからは使用されない(外部クライアント向け)
  3. Embedding Server (packages/db-engine/src/python/embedding_server.py)

    • Ollama API互換のHTTP埋め込みサーバ
    • 複数プロセスから共有利用可能

詳細: docs/architecture.md

データモデル

  • DocumentStorage: 文書の永続化(パス形式のキー)
  • SearchIndex: Vector検索(LanceDB + Ruri Embedding)
  • Section: 分割データ(depth 0-3、トークン数ベース)

詳細: docs/data-model.md

システム全体

  • TypeScript: サーバ、クライアント、CLI、MCP Server
  • Python: LanceDB操作、Vector化(uvで管理)
  • pnpm: モノレポ管理

詳細: docs/architecture.md

プロジェクト構造

search-docs/
├── packages/              # モノレポパッケージ
│   ├── server/           # 検索サーバ
│   ├── client/           # クライアントライブラリ
│   ├── cli/              # CLIツール
│   ├── mcp-server/       # Claude Code統合
│   ├── storage/          # DocumentStorage
│   └── db-engine/        # LanceDB Pythonラッパー
├── docker/               # Docker関連
│   ├── entrypoint.sh    # モード分岐(MCP/Embedding、簡素化済み)
│   └── compose.yaml     # 共有Embeddingサーバ構成例
├── docs/                 # ドキュメント
├── prompts/              # Claude Code設定
│   └── tasks/           # 作業メモ・計画
├── Dockerfile            # マルチステージビルド
├── pyproject.toml        # Python依存関係(uv)
├── pnpm-workspace.yaml   # pnpmワークスペース
└── package.json          # ルートパッケージ

Read the full file on GitHub · 226 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. 2d ago First seen · 226 lines · 2,512 tokens per session scan A a1fbed33b923

Subscribe to this mod's changes

search-docs AGENTS.md is an instructions file published in the GitHub repository otolab/search-docs (1 stars, last pushed 3mo ago), licensed MIT. It adds 2,512 tokens to every session, about $0.0126 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

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

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

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

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

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

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