nrf-mcp
The nrf-mcp server provides tools to browse, search, and analyze the Nordic nRF Connect SDK repository, enabling AI-assisted embedded/IoT development for Nordic hardware.
nrf_list— List files and directories at any path in the SDK repo, with recursive tree view support (up to depth 3)nrf_read— Read contents of any text file (.rstdocs,.c/.hsource,CMakeLists.txt,prj.conf,Kconfig, YAML, etc.), with line range support and auto-truncation for large filesnrf_search— Search across the SDK using GitHub code search with qualifiers (e.g.,path:,extension:) to find code snippets or documentation, with pagination supportnrf_diff— Compare a file between two SDK versions (tags, branches, or SHAs) and view a unified diffnrf_kconfig— Look up aCONFIG_*symbol to retrieve its Kconfig definition, type, default values, and dependencies
The server supports targeting specific SDK versions (defaults to main) and caches responses for performance. It covers documentation, samples (Bluetooth, cellular, Matter, NFC, cryptography, TF-M), libraries, and applications.
Provides tools to browse documentation, list files, and search code within the nRF Connect SDK (sdk-nrf) repository on GitHub.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@nrf-mcp find the peripheral_hr sample and show me its main.c"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
nrf-mcp
MCP server for Nordic nRF Connect SDK development. Provides Claude with tools to browse documentation and sample code from the nrfconnect/sdk-nrf repository.
Tools
Tool | Description |
| List files and directories at a given path (includes file sizes). Supports recursive tree view with |
| Read a file's contents ( |
| Search across the repo using GitHub code search with qualifier support. Returns context snippets and supports pagination |
| Compare a file between two SDK versions (tags, branches, or SHAs). Returns a unified diff |
| Look up a |
Search examples
# Find all uses of a symbol
DFU_TARGET_IMAGE_TYPE_ANY
# Search docs only
FOTA path:doc/nrf
# Search samples only
peripheral_hr path:samples
# Filter by file type
CONFIG_BT_PERIPHERAL extension:conf
bt_le_adv_start extension:cRecursive directory listing
Use depth to get a full project overview in one call:
{ "path": "samples/bluetooth/central_bas", "depth": 2 }Reading specific line ranges
When working with large files, use startLine and endLine to read just the relevant section:
{ "path": "samples/bluetooth/central_bas/src/main.c", "startLine": 1, "endLine": 50 }Paginating search results
Search returns up to 20 results per page. Use the page parameter to fetch more:
{ "query": "bt_le_adv_start extension:c", "page": 2 }Comparing SDK versions
See what changed in a file between releases:
{ "path": "samples/bluetooth/central_bas/src/main.c", "fromRef": "v3.0.0", "toRef": "v3.2.4" }Kconfig symbol lookup
Look up what a prj.conf option does:
{ "symbol": "CONFIG_BT_PERIPHERAL" }Related MCP server: GitHub MCP Server
Setup
Prerequisites
Node.js 18+
GitHub CLI (
gh) authenticated — used to supply a GitHub token at runtime
Install and build
npm install
npm run buildRegister with Claude Code
claude mcp add -s user nrf-mcp -- /path/to/nrf-mcp/run.shRegister with Claude Desktop
Add to ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"nrf-mcp": {
"command": "/path/to/nrf-mcp/run.sh",
"args": []
}
}
}Then restart Claude Desktop.
The run.sh wrapper fetches a fresh token from gh auth token each time the server starts, so no token is ever hardcoded.
Configuration
Variable | Default | Description |
|
| SDK version to target — any git ref (tag, branch, commit SHA) |
| (from | GitHub API token; set explicitly to bypass the |
To target a different SDK version, set the env var in the MCP registration:
claude mcp remove nrf-mcp
claude mcp add -s user -e NRF_SDK_REF=v3.2.4 nrf-mcp -- /path/to/nrf-mcp/run.shRebuild after changes
npm run buildDuring development, use npm run watch to recompile automatically on save.
Testing
Run the end-to-end test suite (requires gh to be authenticated):
npm testThe tests spawn the server via run.sh, exercise all five tools (including recursive listing, line ranges, pagination, snippets, diff, Kconfig lookup, and error handling), and validate input error handling.
Troubleshooting
gh: command not found or empty token
The run.sh script fetches a token via gh auth token. Make sure the GitHub CLI is installed and you are logged in:
gh auth login
gh auth token # should print a tokenGitHub API 401 errors
nrf_search requires authentication. If the token is missing or expired, re-authenticate with gh auth login. For Claude Desktop, ensure run.sh is executable (chmod +x run.sh) — it prepends the Homebrew bin path to find gh.
GitHub rate limit exceeded
Unauthenticated requests are limited to 60/hour. With a valid GITHUB_TOKEN the limit is 5 000/hour. The server automatically retries on rate-limit errors with backoff (up to 30s). Ensure gh auth token returns a token and that run.sh is being used (not node dist/index.js directly).
Tools not appearing in Claude
Claude Code: run
claude mcp listto confirmnrf-mcpis registered, then restart the session.Claude Desktop: restart the app after editing
claude_desktop_config.json. Check the Desktop developer console for MCP startup errors.
Stale results Directory listings and file contents are cached in memory for 5 minutes to reduce API calls. Restart the server to clear the cache.
Wrong SDK version
Confirm the active ref with echo $NRF_SDK_REF in the same shell, or check what's registered:
claude mcp list # shows the -e env vars set at registration timeTo change it, remove and re-add the registration with the new -e NRF_SDK_REF= value.
Available Tools
3 toolsnrf_listA
List the contents of a directory in the nRF Connect SDK repo (nrfconnect/sdk-nrf @ main).
Useful starting paths:
"doc/nrf" → Documentation root (RST files)
"doc/nrf/protocols" → Bluetooth, LTE, Thread, Zigbee docs
"doc/nrf/libraries" → Library reference docs
"doc/nrf/applications" → Application-level docs
"samples" → All sample projects
"samples/bluetooth" → Bluetooth LE samples
"samples/cellular" → LTE/cellular modem samples
"samples/matter" → Matter protocol samples
"samples/nfc" → NFC samples
"samples/tfm" → Trusted Firmware-M samples
"samples/crypto" → Cryptography samples
Returns dirs first, then files, with full paths you can pass to nrf_read.
Inputs: path (required).
nrf_readA
Read the contents of a file from the nRF Connect SDK repo (nrfconnect/sdk-nrf @ main).
Works for any text file: .rst documentation, .c/.h source, CMakeLists.txt, Kconfig, prj.conf, .yaml, README.rst, etc.
Use nrf_list to discover paths first. Examples:
"samples/bluetooth/central_bas/README.rst"
"samples/bluetooth/central_bas/src/main.c"
"samples/bluetooth/central_bas/CMakeLists.txt"
"samples/bluetooth/central_bas/prj.conf"
Inputs: path (required).
nrf_searchA
Search for code or documentation across the nRF Connect SDK repo using GitHub code search.
Supports GitHub search qualifiers to narrow results:
Plain keyword: "DFU_TARGET_IMAGE_TYPE_ANY"
Docs only: "FOTA path:doc/nrf"
Samples only: "peripheral_hr path:samples"
Specific extension: "CONFIG_BT_PERIPHERAL extension:conf"
Source files only: "bt_le_adv_start extension:c"
Headers only: "struct bt_conn extension:h"
Returns matching file paths (up to 20). Use nrf_read to fetch the content. Note: Requires GITHUB_TOKEN for reliable results (unauthenticated search is heavily rate-limited).
Inputs: query (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool has a clearly distinct purpose: nrf_list for directory listing, nrf_read for file reading, and nrf_search for content searching. There is no overlap in functionality, making tool selection straightforward for an agent.
All tool names follow a consistent 'nrf_' prefix with descriptive verbs (list, read, search), using snake_case uniformly. This predictable pattern enhances readability and reduces confusion.
Three tools are appropriate for the server's purpose of exploring the nRF Connect SDK repo, covering listing, reading, and searching. It's slightly minimal but reasonable for this focused domain, with no unnecessary tools.
The tool set provides complete coverage for exploring the SDK repo: listing directories, reading files, and searching content. There are no obvious gaps, as these tools enable agents to navigate and retrieve information effectively without dead ends.
Maintenance
Related MCP Connectors
Augments MCP Server - A comprehensive framework documentation provider for Claude Code
An MCP server that gives your AI access to the source code and docs of all public github repos
Nifty's MCP server — exposes tasks, projects, messages, and files as tools for AI agents.
MCP server for accessing curated awesome list documentation
Related MCP Servers
- AlicenseBqualityDmaintenanceAn MCP server that enables Claude and other compatible LLMs to interact with the GitHub API, supporting features like creating issues, retrieving repository information, listing issues, and searching repositories.4ISC
- AlicenseBqualityDmaintenanceAn MCP server that allows Claude and other MCP-compatible LLMs to interact with the GitHub API, supporting features like creating issues, getting repository information, listing issues, and searching repositories.4ISC
- FlicenseNot gradedqualityNot gradedmaintenanceAn MCP server that enables Claude to generate, search, and manage documentation for codebases using vector embeddings and semantic search, providing tools for creating user guides, technical documentation, code explanations, and architectural diagrams.6-
- FlicenseNot gradedqualityDmaintenanceA working MCP server that connects to the real GitHub API, enabling users to manage repositories, issues, pull requests, and more through natural language in Claude Desktop.-