Skip to main content

fw-context

Build-aware code intelligence for AI coding agents working on embedded C and C++ firmware.

fw-context builds a persistent semantic index from compile_commands.json and the libclang AST, then exposes it to coding agents through MCP. Instead of reconstructing your firmware through repeated file reads and text searches, the agent can query the program structure produced by the active build configuration.

It helps agents answer questions such as:

  • Which implementation is active in this build?
  • Who calls this function, directly or indirectly?
  • Where is this callback registered?
  • Which function-pointer assignments can reach this call site?
  • Which code is excluded by preprocessing?
  • What will be affected if this API changes?
  • How does execution flow from an ISR to application code?

The goal is not to give the model more source code. It is to give it the smallest useful, build-aware context needed for the current task.

Results from a real firmware review

In the included firmware review case study, fw-context was used on an nRF52/Mbed OS project containing approximately 67,000 lines of C and C++:

  • 115 changed files reviewed by 8 parallel subagents
  • 19 findings across memory safety, concurrency, API use and dead code
  • 9 findings that depended on semantic relationships not available from ordinary text search alone
  • approximately 54,000 context tokens used by fw-context queries
  • an estimated 5.8 million tokens for the equivalent broad grep and file-reading workflow

The case study includes the review output, methodology and per-tool token analysis so the claims can be inspected rather than treated as a black-box benchmark.

Quick start

Prerequisites

  • Python 3.11 or newer
  • libclang
  • a project that can produce compile_commands.json
  • an MCP-capable coding agent such as Claude Code or OpenCode

Ollama is optional for the core index: symbols, full-text search, call graph and source come from libclang and SQLite only. With the default configuration, Ollama also computes the vector embeddings (semantic_search, the re-rank step of smart_search) and the symbol analysis (explain_symbol, symbol descriptions). Without Ollama, these features fall back to full-text search or return raw prompts. See Ollama.

pip install fw-context-mcp

Install the current source version

git clone https://github.com/turbyho/fw-context-mcp.git ~/.fw-context/src
cd ~/.fw-context/src
make install

Register fw-context with the supported coding agents detected in your project:

cd /path/to/your/firmware
fw-context init

Build and index the firmware:

cd /path/to/your/firmware
fw-context index --build

Then restart the coding agent and ask it questions about the project. The index is persistent and incremental; after the initial run, changed translation units are reprocessed instead of rebuilding the entire index.

See the Quick Start and Installation Guide for platform-specific setup and supported build systems.

What fw-context changes

Without a semantic project index, an AI coding agent usually starts by opening files, searching for names, following includes and trying to infer relationships that are implicit in the build. In embedded firmware this reconstruction is often the dominant part of the task.

That approach can fail in predictable ways:

  • reviewing source files that are not part of the active build
  • following the wrong preprocessor branch
  • missing callback registrations and indirect calls
  • selecting an inactive driver or platform implementation
  • treating declarations found by text search as reachable code
  • consuming large amounts of context on vendor code and unrelated files

fw-context moves much of that reconstruction into a reusable compiler-derived index. The agent can request exact symbol bodies, callers, callees, references, active macros, callback relationships, inheritance edges and other targeted information without reading whole source trees.

Why embedded firmware is different

In many application-level projects, the source files visible in the repository are reasonably close to the program being executed. Embedded C and C++ projects often have a much larger gap between the source tree and the resulting program.

The active firmware depends on factors such as:

  • compiler flags and preprocessor definitions
  • target, board and product configuration
  • include paths and generated headers
  • Kconfig and Devicetree selections
  • selected driver and HAL implementations
  • templates, inheritance and virtual dispatch
  • callbacks, interrupt handlers and function pointers
  • vendor SDK and RTOS configuration

A repository may therefore contain several plausible implementations of the same subsystem while only one is compiled for the selected target. An agent can reason convincingly about the wrong implementation unless it first reconstructs the build context correctly.

How it works

fw-context indexes the project through the same compilation database used by build tooling and language servers.

flowchart LR
    CCJ[compile_commands.json] & SRC[(source files)] --> LIBCLANG[libclang<br/>AST parser]
    LIBCLANG --> SYMBOLS[symbols<br/>name, kind, USR<br/>signature, ifdef-filtered source body<br/>docstring, tokens] & FILES[files<br/>path, language<br/>ifdef-filtered content<br/>project/SDK sources] & REFS[refs &amp; call graph<br/>fp_assignments<br/>indirect_call_sites] & INHERIT[inheritance<br/>&amp; overrides<br/>virtual dispatch] & MACROS[macros<br/>params, value<br/>&amp; expanded value<br/>FTS5 searchable] & ENRICH[optional enrichment<br/>embeddings &amp; summaries<br/>hotspot cache]
    SYMBOLS & FILES & REFS & INHERIT & MACROS & ENRICH --> MCP[MCP server<br/>39 tools]
    MCP --> LLM[AI coding agent]

The index contains:

  • symbol definitions, signatures, source extents and documentation
  • references, direct call edges and recursive caller paths
  • function-pointer assignments and indirect call sites
  • callback registrations and invocation relationships
  • active, preprocessor-filtered file content
  • macro parameter lists, replacement text and expanded values
  • inheritance, overrides and virtual-dispatch relationships
  • translation-unit and project/vendor metadata
  • optional embeddings and LLM-generated summaries

The MCP server exposes this information as compact high-level queries optimized for repeated use by an AI agent.

Typical use cases

  • build-aware review of firmware commits
  • tracing execution across ISRs, work queues, tasks and callbacks
  • locating all callers and references of an API
  • identifying the implementation selected by the current build
  • impact analysis before changing a function signature or data type
  • navigating unfamiliar firmware without reading complete files
  • finding dead-code candidates and unreferenced symbols
  • separating project code from SDK and vendor code
  • reducing irrelevant source text sent to the model

fw-context supports Zephyr, PlatformIO, Mbed OS, Arduino, ESP-IDF, generic CMake, Makefile-based projects and custom builds that can provide a compilation database. Additional setup paths are documented for Keil, IAR, STM32CubeIDE and TI Code Composer Studio.

Why not just use clangd or another LSP?

clangd already uses compilation commands and is excellent at editor-oriented tasks such as diagnostics, completion, go-to-definition and reference lookup. fw-context does not replace it.

fw-context targets a different interface and workload:

  • persistent project-wide data prepared for repeated agent queries
  • MCP tools that return compact, structured semantic context
  • recursive caller and impact-analysis queries
  • callback and function-pointer relationship modelling
  • active source content suitable for targeted retrieval
  • project/vendor classification and firmware-specific workflows
  • optional cached enrichment shared across repeated analyses

Use clangd for interactive editing. Use fw-context when an AI agent needs structured, reusable context for reviewing, understanding or navigating the built firmware.

Documentation

Project maturity

fw-context is functional and is used on real embedded C and C++ projects, but its interfaces and indexing behaviour are still evolving. Bug reports, incorrect results, unsupported build configurations and reproducible edge cases are particularly valuable.

The project is local-first: source code and the compiler-derived index remain on the developer's machine unless optional external services are explicitly configured.

Background

The project grew from a recurring failure mode in AI-assisted firmware work: coding agents frequently spent more effort reconstructing the active program than reasoning about the engineering question itself.

For the longer explanation, read: Why AI Coding Agents Keep Making the Same Mistakes When Analyzing Embedded Firmware


The compiler has already reconstructed your program. Let your coding agent use it.

Metadata

Release files for fw-context-mcp 0.33.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fw-context-mcp 0.33.0
File Size Uploaded
fw_context_mcp-0.33.0.tar.gz 2.4 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for fw-context-mcp 0.33.0
File Interpreter ABI Platform
fw_context_mcp-0.33.0-py3-none-any.whl Python 3 none any Details

Total release size: 4.1 MB

Release files / fw_context_mcp-0.33.0.tar.gz

Download URL fw_context_mcp-0.33.0.tar.gz
Size 2.4 MB
Tags Source
SHA-256 checksum
How to use checksums
54900523c6d85a596269957cae9543cbe27346f6d2f25d595abddb7d27245410
BLAKE2b-256 checksum
How to use checksums
e6156bcf9f1de8f09cb3ff2b858d812788f2ecf6889db08a533b3ea2b3487640
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / fw_context_mcp-0.33.0-py3-none-any.whl

Download URL fw_context_mcp-0.33.0-py3-none-any.whl
Size 1.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
12719662664a4ff01b08bf3591be8bc1cb8567a913a2f315f130d3f3eb4399ea
BLAKE2b-256 checksum
How to use checksums
d8b9812762c1e70c4f7cd8810559cd6d81383d04d3c5b05c55826bc4b256bf9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

This release

0.33.0 This release

2 release files

0.32.0

2 release files

0.31.0

2 release files

0.28.2

2 release files

0.28.1

2 release files

0.28.0

2 release files

0.27.6

2 release files

0.27.5

2 release files

0.27.4

2 release files

0.27.3

2 release files

0.27.2

2 release files

0.27.1

2 release files

0.27.0

2 release files

0.26.0

2 release files

0.24.0

2 release files

0.23.0

2 release files

0.22.3

2 release files

0.22.2

2 release files

0.22.1

2 release files

0.22.0

2 release files

0.21.0

2 release files

0.20.2

2 release files

0.20.1

2 release files

0.20.0

2 release files

0.19.1

2 release files

0.18.2

2 release files

0.18.1

2 release files

0.18.0

2 release files

0.14.3

1 release file

0.11.1

2 release files

0.11.0

2 release files

0.10.1

2 release files

0.10.0

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.8

2 release files

0.8.7

2 release files

0.8.6

2 release files

0.8.5

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.4

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.1.7

1 release file

0.1.6

1 release file

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page