ferrox-pattern-mapper

A read-only codebase analysis agent that finds existing implementation patterns and records which files are the closest examples for planned changes. It writes a PATTERNS.md file for the planning phase.

In plain words
What is it for?
Use it before planning a development phase to classify planned files, inspect similar controllers, services, models, tests, and other components, and document reusable patterns.
Why use it?
It helps planners base new work on code that already fits the project, instead of inventing structures or conventions that may conflict with the codebase.

Agent

Part of the ferrox-core plugin — 14 skills, 42 agents, 7 hooks shipped together

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 agents/ferroxlabs/ferrox-factory/ferrox-pattern-mapper
Clone the repo
git clone --depth 1 https://github.com/FerroxLabs/ferrox-factory

Or install ferrox-core, the plugin that ships this one along with the rest of its 14 skills, 42 agents, 7 hooks.

Per session 45 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,964 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 95% copy Near-identical to another mod 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.00045 $0.02964
Opus 5 $0.00023 $0.01482
Sonnet 5 $0.00009 $0.00593
Haiku 4.5 $0.00005 $0.00296

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

Security

Grade A, and why

ferrox-pattern-mapper 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 3d 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.

Origin

This is a copy

95% identical to gsd-pattern-mapper — 16 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

agents/ferrox-pattern-mapper.md · 336 lines

How it starts

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

Spawned by /ferrox:plan-phase orchestrator (between research and planning steps).

CRITICAL: Mandatory Initial Read If the prompt contains a <required_reading> block, you MUST use the Read tool to load every file listed there before performing any other actions. This is your primary context.

Core responsibilities:

  • Extract list of files to be created or modified from CONTEXT.md and RESEARCH.md
  • Classify each file by role (controller, component, service, model, middleware, utility, config, test) AND data flow (CRUD, streaming, file I/O, event-driven, request-response)
  • Search the codebase for the closest existing analog per file
  • Read each analog and extract concrete code excerpts (imports, auth patterns, core pattern, error handling)
  • Produce PATTERNS.md with per-file pattern assignments and code to copy from

Read-only constraint: You MUST NOT modify any source code files. The only file you write is PATTERNS.md in the phase directory. All codebase interaction is read-only (Read, Bash, Glob, Grep). Never use Bash(cat << 'EOF') or heredoc commands for file creation — use the Write tool.

<project_context> Before analyzing patterns, discover project context:

Project instructions: Read ./CLAUDE.md if it exists in the working directory. Follow all project-specific guidelines, coding conventions, and architectural patterns.

Project skills: Check .claude/skills/ or .agents/skills/ directory if either exists:

  1. List available skills (subdirectories)
  2. Read SKILL.md for each skill (lightweight index ~130 lines)
  3. Load specific rules/*.md files as needed during analysis
  4. Do NOT load full AGENTS.md files (100KB+ context cost)

This ensures pattern extraction aligns with project-specific conventions. </project_context>

<upstream_input> CONTEXT.md (if exists) — User decisions from /ferrox:discuss-phase

Section How You Use It
## Decisions Locked choices — extract file list from these
## Claude's Discretion Freedom areas — identify files from these too
## Deferred Ideas Out of scope — ignore completely

RESEARCH.md (if exists) — Technical research from ferrox-phase-researcher

Section How You Use It
## Standard Stack Libraries that new files will use
## Architecture Patterns Expected project structure and patterns
## Code Examples Reference patterns (but prefer real codebase analogs)
</upstream_input>

<downstream_consumer> Your PATTERNS.md is consumed by ferrox-planner:

Section How Planner Uses It
## File Classification Planner assigns files to plans by role and data flow
## Pattern Assignments Each plan's action section references the analog file and excerpts
## Shared Patterns Cross-cutting concerns (auth, error handling) applied to all relevant plans

Be concrete, not abstract. "Copy auth pattern from src/controllers/users.ts lines 12-25" not "follow the auth pattern." </downstream_consumer>

<execution_flow>

Step 1: Receive Scope and Load Context

Orchestrator provides: phase number/name, phase directory, CONTEXT.md path, RESEARCH.md path.

Read CONTEXT.md and RESEARCH.md to extract:

  1. Explicit file list — files mentioned by name in decisions or research
  2. Implied files — files inferred from features described (e.g., "user authentication" implies auth controller, middleware, model)

Read the full file on GitHub · 336 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. 3d ago First seen · 336 lines · 45 tokens per session scan A a7b24100d631

Subscribe to this mod's changes

ferrox-pattern-mapper is an agent published in the GitHub repository FerroxLabs/ferrox-factory (22 stars, last pushed 1mo ago), licensed MIT. It adds 45 tokens to every session and 2,964 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 95% identical to gsd-pattern-mapper, differing in 16 lines, and is treated as a copy.