Skip to main content

Build-aware code intelligence MCP server for embedded C/C++ firmware (Mbed OS, Zephyr, PlatformIO)

Project description

fw-context

mcp-name: io.github.turbyho/fw-context-mcp

Python MCP License Tests Glama

MCP server for embedded C/C++ firmware — gives AI assistants (Claude Code, Cursor, OpenCode, etc.) real understanding of your codebase. Parses your actual build with libclang, extracts every symbol, and builds a persistent index with full-text search, call graph, and vector embeddings.

No hallucination. No grepping. No reading thousands of framework headers into context.

What it does

Your AI assistant goes from guessing to knowing:

"What does uart_init do and who calls it?"get_symbol_context("uart_init") — body, callers, callees in one call.

"Find all BLE advertising functions and how they're connected."search_code("ble advertising", kind="function")find_call_path("gap_init", "start_advertising")

"Show me the implementation of adc_read — not the declaration."get_source("adc_read") — exact body via libclang, no file reading.

"What would break if I change spi_transfer?"find_all_callers_recursive("spi_transfer") — every caller, direct and indirect.

"Give me a map of modem_msg.cpp before I read it."get_file_map("src/modem_msg.cpp") — 426 symbols grouped by kind.

21 MCP tools — symbol search, source reading, call-graph traversal, hotspot analysis, dead code detection, vector search. All backed by real compiler flags from compile_commands.json#ifdef-aware, not grep.

Quick start

1. Install

Prerequisites

Linux (apt) macOS (brew)
Python 3.11+ sudo apt install python3 brew install python@3.12
uv curl -LsSf https://astral.sh/uv/install.sh | sh brew install uv
bear sudo apt install bear brew install bear
libclang sudo apt install libclang-dev brew install llvm
Ollama (optional) curl -fsSL https://ollama.com/install.sh | sh brew install ollama

Linux

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

macOS

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

2. Ollama (optional)

Powers smart_search (natural-language search) and explain_symbol. Works without Ollama too — the AI assistant processes results on its own.

# Install
curl -fsSL https://ollama.com/install.sh | sh   # Linux
brew install ollama                               # macOS

# Pull models
ollama pull qwen2.5-coder:14b          # LLM (~9 GB VRAM, or :7b for 4 GB)
ollama pull mxbai-embed-large:latest   # embedding model for vector search

# Start daemon
ollama serve &

3. Register with your AI assistant

fw-context init

4. Update

cd ~/.fw-context/src && make update

5. Index your firmware project

cd your-firmware-project

# One command — auto-detects build system, runs clean build, indexes:
fw-context index

# Skip the build step (use existing compile_commands.json):
fw-context index --no-build

Auto-detection: mbed-os (.mbed, mbed-os/), Zephyr (west.yml), PlatformIO (platformio.ini), or any build with bear.

What happens: On fw-context index without arguments, the tool:

  1. Detects your build system
  2. Runs a clean build via bear / west / pio to produce a complete compile_commands.json
  3. Parses every translation unit with libclang
  4. Builds the SQLite index with symbols, references, and embeddings

Subsequent runs are incremental — seconds for a few changed files. Use --no-build if you already have an up-to-date compile_commands.json.

6. Restart your assistant and start asking about your code

For detailed prerequisites, Ollama setup, and AI assistant integration: Installation guide →

Why not just use LSP?

LSP servers (clangd, ccls) are excellent for interactive editing. But they have limitations for AI-assisted exploration:

Limitation fw-context solution
No full-text search across the codebase FTS5 over 6 columns — find "all functions related to modem init"
Index dies with the server — rebuild from scratch Persistent SQLite file — survives reboots, reads in milliseconds
Editor protocol, not AI protocol MCP tools purpose-built for AI assistant workflow
Blind to which #ifdef branch is active Uses real compiler flags from compile_commands.json

Use clangd for editing, fw-context for AI-assisted exploration.

Architecture

Data flow

   BUILD                          INDEX                          QUERY
   =====                          =====                          =====
   bear / west / pio    libclang parses each TU          AI assistant calls
   cmake / make         extracts symbols + refs          MCP tools over
        │               generates embeddings            JSON-RPC (stdio)
        ▼                       │                              │
   compile_commands      SQLite db on disk               lookup_symbol(…)
   .json                 ~/.fw-context/index/            search_code(…)
                         │            │                  find_callers(…)
                         ▼            ▼                  explain_symbol(…)
                    symbols + refs   vec0                 get_symbol_context(…)
                    (FTS5 index)   (vector KNN)                 │
                                                          ▼
                                                    AI assistant answers
                                                    your question about
                                                    the code

Components

   CLI (fw-context)            MCP server (fw-context-mcp)          Ollama (optional)
   ================            ===========================          ==================
   fw-context index            exposes 21 tools over               local LLM runtime
   fw-context export           JSON-RPC (stdio)                    HTTP :11434
   fw-context watch                  │                                  │
   fw-context status           search_code ───────────── lookup   smart_search ──▶ translates NL → FTS5 terms
   fw-context reset            lookup_symbol ─────────── prefix   explain_symbol ─▶ explains function
   fw-context init             smart_search ──────────── NL       embeddings ────▶ mxbai-embed-large
   fw-context search           get_file_map ──────────── file structure by kind
                               get_source ────────────── body
                               get_symbol_context ────── body+callers+callees
                               find_callers ──────────── direct callers
                               find_references ───────── all uses
                               find_call_path ────────── BFS in call graph
                               find_all_callers_recursive  transitive callers
                               find_callees_recursive ── transitive callees
                               find_dead_code ────────── never called
                               find_hotspots ─────────── most-called
                               find_wrapper_callers ──── wrapper→driver
                               trace_data_flow ───────── data flow paths
                               get_active_build ──────── index health
                               reindex_file ──────────── re-parse one file
                               reset_index ───────────── delete + rebuild
                               list_projects ─────────── all indexed projects
                               check_ollama ──────────── verify LLM
Component Runs as Purpose
CLI (fw-context) User command Index, export, watch, status, reset, init, search
Indexer Called by CLI libclang parses every TU, stores in SQLite + FTS5 + vec0
MCP server (fw-context-mcp) Subprocess (AI assistant) 21 tools over JSON-RPC — search, graph, source, maintenance
Ollama (optional) Local daemon NL search, symbol explanation, embedding generation

Key capabilities

  • Fast lookups — FTS5 full-text search, prefix/exact symbol lookup, call-graph traversal
  • Natural-language search"how does the modem connect?" → finds network_registration, modem_attach, … (Ollama, optional)
  • Vector search — semantic similarity via sqlite-vec + Ollama embeddings, hybrid FTS5+vector re-ranking
  • Graph analytics — call paths, transitive callers/callees, dead code detection, hotspot analysis
  • Indirect call detection — resolves function-pointer arguments at direct call sites, uncovering call-graph edges that grep/cscope miss
  • Incremental indexing — only changed files re-parsed; auto-reindex on query detects and fixes staleness
  • Offline-first — index is a file on disk at ~/.fw-context/index/. No daemon, no cloud, no network.
  • #ifdef-aware — uses real compiler flags; sees exactly what your compiler sees

Supported ecosystems

Works with any build system that produces compile_commands.json:

Ecosystem Auto-detection Build command
Mbed OS .mbed, mbed-os/, mbed_app.json bear -- mbed compile --clean
Zephyr RTOS west.yml or zephyr/ west build -b <board> --pristine
PlatformIO platformio.ini pio run --target compiledb
Custom Any [build] command override User-specified

fw-context index handles the build automatically. Use --no-build to skip and use an existing compile_commands.json.

Subsequent runs are incremental — seconds for a few changed files.

Documentation

Document Covers
Installation Prerequisites, install, upgrade, Ollama setup, AI assistant integration
Tools Reference All 21 MCP tools, 9 CLI commands, internal workings, search pipeline
Configuration .fw-context/config.toml — global defaults, per-project overrides, every setting
MCP Server JSON-RPC protocol, tool schemas, error handling, debugging

Directory layout

~/.fw-context/
├── config.toml              # global defaults
├── .venv/                   # Python virtual environment
│   └── bin/
│       ├── fw-context       # CLI
│       └── fw-context-mcp   # MCP server
└── index/
    └── <project-id>/
        └── index.db         # SQLite + FTS5 + vec0 + refs

your-firmware/
├── .fw-context/
│   └── config.toml          # per-project overrides
└── compile_commands.json

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fw_context_mcp-0.3.0.tar.gz (125.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fw_context_mcp-0.3.0-py3-none-any.whl (97.2 kB view details)

Uploaded Python 3

File details

Details for the file fw_context_mcp-0.3.0.tar.gz.

File metadata

  • Download URL: fw_context_mcp-0.3.0.tar.gz
  • Upload date:
  • Size: 125.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for fw_context_mcp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f7adbc805f3cba4c1606ad14f99045936c8675908aa4d9b01d088f297a534181
MD5 4a9f178b8b0fd35480d1a4aa77bf3e14
BLAKE2b-256 9e7b3e2b4da450b6aa30fe12dc164287dacb4106e4e1f58779484619414a2bf8

See more details on using hashes here.

File details

Details for the file fw_context_mcp-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: fw_context_mcp-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 97.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for fw_context_mcp-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6970f623d5c99504aff085c9c425e663acee81ee14dd6be8dc0792637ed7cec
MD5 7fb7ef6d21b7fadfadc7b2f9411dbcbc
BLAKE2b-256 0149943aad09a3068231022d2bec46a607eae944330f6b7986c088993c78fcf7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page