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 Glama

Working on an embedded C/C++ project — Zephyr, PlatformIO, Mbed OS, Arduino, FreeRTOS, and beyond — and want more from your AI assistant than just reading files?

Your AI agent can open main.cpp, but it doesn't know who calls uart_init, which functions are dead, or how data flows from a sensor to the modem. Every question burns tokens repeatedly re-reading headers and source, and you still end up in the wrong #ifdef branch.

fw-context gives your AI agent a compiler-accurate map of your codebase. It parses your actual build flags from compile_commands.json with libclang and builds a persistent index that sees active #ifdef branches exactly like your compiler does. 27 tools for symbol lookup, call-graph traversal, full-text and semantic search, dead code detection, and hotspot analysis. Ask in natural language, get precise answers. No grepping. No hallucination.

If your AI agent works with embedded C/C++, you want this.

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.

27 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

Component Linux (apt) macOS (brew)
Python 3.11+ python3 python
uv uv uv
bear bear bear
libclang libclang-dev llvm
Ollama (optional) ollama ollama
# Linux
sudo apt install python3 bear libclang-dev

# macOS
brew install python bear llvm

# Both — uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Both — Ollama (optional)
curl -fsSL https://ollama.com/install.sh | sh   # Linux
brew install ollama                               # 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 it — the AI assistant processes results on its own. See the installation guide for detailed setup.

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

graph TB
    subgraph BUILD["Build"]
        build[Bear / West / PIO<br/>cmake / make]
        cc[(compile_commands.json)]
        build --> cc
    end
    subgraph INDEX["Index"]
        libclang[libclang parses each TU<br/>extracts symbols + refs<br/>generates embeddings]
        db[(SQLite on disk<br/>~/.fw-context/index/)]
        cc --> libclang
        libclang --> db
    end
    subgraph QUERY["Query"]
        mcp[MCP tools<br/>JSON-RPC stdio]
        ai[AI assistant answers<br/>your question about the code]
        mcp --> ai
    end
    db --> mcp

Components

graph LR
    cli[CLI: fw-context<br/>index, export, watch, status]
    server[MCP Server: fw-context-mcp<br/>27 tools across search, source,<br/>graph, and maintenance categories]
    ollama[Ollama<br/>optional]
    db[(SQLite + FTS5<br/>+ vec0 + refs)]

    cli -->|writes| db
    server -->|reads| db
    ollama -->|HTTP| server
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) 27 tools over JSON-RPC — search, graph, source, maintenance
Ollama (optional) Local daemon NL search, symbol explanation, embedding generation

Features

  • 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 27 MCP tools, 10 CLI commands, internal workings, search pipeline
Configuration .fw-context/config.toml + local.toml — shared project config and local developer overrides
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          # shared project config (commit to git)
│   └── local.toml           # local developer overrides (gitignored)
└── 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.7.0.tar.gz (199.8 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.7.0-py3-none-any.whl (140.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fw_context_mcp-0.7.0.tar.gz
  • Upload date:
  • Size: 199.8 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.7.0.tar.gz
Algorithm Hash digest
SHA256 51f76acae0cb3223a1e0962d9bf407a6e69effdc5f1b9af9623d71b20e1336e8
MD5 40e40ea9a4efd5dba610d669090da38e
BLAKE2b-256 4b474e6c67683acbd697e8ec9e0105c23871410e9f43f6decf9f53554c531ed4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fw_context_mcp-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 140.0 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3958f31ca8664830517e73722c64342f5f9fc3f96608aabb056cdefb5661d0d5
MD5 db86b902f79a1bb80155815b9cc86a96
BLAKE2b-256 4f5a35bd329e81cba3bf0974cc3dc96b394971d5e962bdc14a12912caa196da5

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