ContextAtlas AGENTS.md

Repository instructions for ContextAtlas, a code-search tool that combines word matching with meaning-based search and builds relevant context for AI coding assistants.

In plain words
What is it for?
Use them when building, developing, running, indexing, or searching the ContextAtlas codebase, or starting its MCP server.
Why use it?
They give coding agents the project overview, commands, architecture, and rules needed to work safely in the repository.

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

Made for: Codex, OpenCode.

Per session 1,144 This file is loaded in full into every session.
When invoked 1,144 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.01144 $0.01144
Opus 5 $0.00572 $0.00572
Sonnet 5 $0.00229 $0.00229
Haiku 4.5 $0.00114 $0.00114

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

Security

Grade A, and why

ContextAtlas 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 · 90 lines

How it starts

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

AGENTS.md

This file provides guidance to AI coding agents when working with code in this repository.

Project Overview

ContextAtlas 是一个为 AI 代码助手设计的语义检索引擎,采用混合搜索(向量 + 词法)、智能上下文扩展和 Token 感知打包策略。

Development Commands

# Build
pnpm build                    # 编译 TypeScript (tsup)

# Development
pnpm dev                      # Watch 模式开发

# Run locally
pnpm start                    # 运行编译后的 CLI
node dist/index.js            # 直接运行

# CLI usage
contextatlas init            # 初始化配置文件 (~/.contextatlas/.env)
contextatlas index [path]    # 索引代码库
contextatlas search          # 本地搜索
contextatlas mcp             # 启动 MCP 服务端

Architecture

Core Pipeline

索引: Crawler → Processor → SemanticSplitter → Indexer → VectorStore/SQLite
搜索: Query → Vector+FTS Recall → RRF Fusion → Rerank → GraphExpander → ContextPacker

Architecture Layers

CLI commands  →  application layer  →  memory/search domain  →  storage
MCP adapters  →  (Zod schema only)  →  (business logic)      →  (SQLite/LanceDB)

MCP tools (src/mcp/tools/) are thin adapters: Zod schema validation + protocol formatting. Business logic lives in src/application/ (memory, retrieval) and src/memory/ (domain). CLI commands (src/cli/commands/) call application layer directly, bypassing MCP adapters.

Key Modules

Module Location Responsibility
Application Layer src/application/memory/ Memory 工具业务逻辑,CLI 和 MCP adapter 统一入口
Retrieval Application src/application/retrieval/ 检索用例编排,结果卡片渲染
SearchService src/search/SearchService.ts 搜索总编排层,串联 recall、rerank、cutoff、expand、pack
HybridRecallEngine src/search/HybridRecallEngine.ts 混合召回执行层,负责向量/词法召回、FTS 降级与 RRF 融合
RerankPolicy src/search/RerankPolicy.ts rerank 池选择与 Smart TopK cutoff 策略
SnippetExtractor src/search/SnippetExtractor.ts rerank 文本构造与命中片段截取
MemoryStore src/memory/MemoryStore.ts 记忆 facade,协调 feature/project-meta/decision/long-term 四类子存储
MemoryStoreBootstrap src/memory/MemoryStoreBootstrap.ts 项目注册、只读/可写初始化与兼容导入引导
ProjectMetaStore src/memory/ProjectMetaStore.ts checkpoint、profile、catalog、global memory 持久化
FeatureMemoryRepository src/memory/FeatureMemoryRepository.ts feature memory 的 SQLite CRUD
FeatureMemoryCatalogCoordinator src/memory/FeatureMemoryCatalogCoordinator.ts feature memory 与 MemoryRouter catalog 的同步
DecisionStore src/memory/DecisionStore.ts 架构决策记录的持久化与映射
LongTermMemoryService src/memory/LongTermMemoryService.ts 长期记忆追加、检索、合并、状态与清理
GraphExpander src/search/GraphExpander.ts 三阶段上下文扩展 (E1 邻居/E2 面包屑/E3 导入)
ContextPacker src/search/ContextPacker.ts 段落合并和 Token 预算控制
SemanticSplitter src/chunking/SemanticSplitter.ts AST 语义分片器 (Tree-sitter)
VectorStore src/vectorStore/index.ts LanceDB 适配层
Database src/db/index.ts SQLite + FTS5 元数据和全文索引
MCP Server src/mcp/server.ts Model Context Protocol 服务端实现

Read the full file on GitHub · 90 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 · 90 lines · 1,144 tokens per session scan A b17ca16867d1

Subscribe to this mod's changes

ContextAtlas AGENTS.md is an instructions file published in the GitHub repository codefromkarl/ContextAtlas (29 stars, last pushed 3mo ago), licensed MIT. It adds 1,144 tokens to every session, about $0.0057 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-30.