loading…
Search for a command to run...
loading…
An MCP server for Nordic nRF Connect SDK development that enables users to list, read, and search documentation and sample code from the nrfconnect/sdk-nrf repo
An MCP server for Nordic nRF Connect SDK development that enables users to list, read, and search documentation and sample code from the nrfconnect/sdk-nrf repository. It provides Claude with specialized tools to navigate SDK resources, source files, and configuration examples directly through the GitHub API.
MCP server for Nordic nRF Connect SDK development. Provides Claude with tools to browse documentation and sample code from the nrfconnect/sdk-nrf repository.
| Tool | Description |
|---|---|
nrf_list |
List files and directories at a given path (includes file sizes). Supports recursive tree view with depth (max 3) |
nrf_read |
Read a file's contents (.rst docs, .c/.h source, CMakeLists.txt, prj.conf, etc.). Supports startLine/endLine for partial reads. Large files (>500 KB) are streamed and auto-truncated |
nrf_search |
Search across the repo using GitHub code search with qualifier support. Returns context snippets and supports pagination |
nrf_diff |
Compare a file between two SDK versions (tags, branches, or SHAs). Returns a unified diff |
nrf_kconfig |
Look up a CONFIG_* symbol — finds its Kconfig definition, type, defaults, and dependencies |
# 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:c
Use depth to get a full project overview in one call:
{ "path": "samples/bluetooth/central_bas", "depth": 2 }
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 }
Search returns up to 20 results per page. Use the page parameter to fetch more:
{ "query": "bt_le_adv_start extension:c", "page": 2 }
See what changed in a file between releases:
{ "path": "samples/bluetooth/central_bas/src/main.c", "fromRef": "v3.0.0", "toRef": "v3.2.4" }
Look up what a prj.conf option does:
{ "symbol": "CONFIG_BT_PERIPHERAL" }
npm install
npm run build
claude mcp add -s user nrf-mcp -- /path/to/nrf-mcp/run.sh
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.
| Variable | Default | Description |
|---|---|---|
NRF_SDK_REF |
main (set via nrfSdkRef in package.json) |
SDK version to target — any git ref (tag, branch, commit SHA) |
GITHUB_TOKEN |
(from gh auth token) |
GitHub API token; set explicitly to bypass the gh CLI |
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.sh
npm run build
During development, use npm run watch to recompile automatically on save.
Run the end-to-end test suite (requires gh to be authenticated):
npm test
The 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.
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 token
GitHub 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 mcp list to confirm nrf-mcp is registered, then restart the session.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 time
To change it, remove and re-add the registration with the new -e NRF_SDK_REF= value.
Добавь это в claude_desktop_config.json и перезапусти Claude Desktop.
{
"mcpServers": {
"nrf-mcp": {
"command": "npx",
"args": []
}
}
}