π REFACTORED: Version 1.0.0 represents a complete rewrite that drastically simplified everything. We removed all the complex caching, abstractions, and "enterprise" patterns. Because sometimes less is more, and more is just showing off.
π ASYNC UPDATE: Version 1.0.1 migrated to FastMCP 2.x for modern async goodness. Because who doesn't love adding
await
to everything?
π¨ No Nix/NixOS Required! This tool works on any system - Windows, macOS, Linux. You're just querying web APIs.
{
"mcpServers": {
"nixos": {
"command": "uvx",
"args": ["mcp-nixos"]
}
}
}
{
"mcpServers": {
"nixos": {
"command": "nix",
"args": ["run", "github:utensils/mcp-nixos", "--"]
}
}
}
{
"mcpServers": {
"nixos": {
"command": "docker",
"args": ["run", "--rm", "-i", "ghcr.io/utensils/mcp-nixos"]
}
}
}
That's it. Your AI assistant now has access to real NixOS data instead of making things up. You're welcome.
MCP-NixOS is a Model Context Protocol server that gives your AI assistant accurate, real-time information about:
- NixOS packages (130K+ packages that actually exist)
- Configuration options (22K+ ways to break your system)
- Home Manager settings (4K+ options for the power users)
- nix-darwin configurations (1K+ macOS settings Apple doesn't want you to touch)
- Package version history via NixHub.io (Find that ancient Ruby 2.6 with commit hashes)
nixos_search(query, type, channel)
- Search packages, options, or programsnixos_info(name, type, channel)
- Get detailed info about packages/optionsnixos_stats(channel)
- Package and option countsnixos_channels()
- List all available channelsnixos_flakes_search(query)
- Search community flakesnixos_flakes_stats()
- Flake ecosystem statistics
nixhub_package_versions(package, limit)
- Get version history with commit hashesnixhub_find_version(package, version)
- Smart search for specific versions
home_manager_search(query)
- Search user config optionshome_manager_info(name)
- Get option details (with suggestions!)home_manager_stats()
- See what's availablehome_manager_list_options()
- Browse all 131 categorieshome_manager_options_by_prefix(prefix)
- Explore options by prefix
darwin_search(query)
- Search macOS optionsdarwin_info(name)
- Get option detailsdarwin_stats()
- macOS configuration statisticsdarwin_list_options()
- Browse all 21 categoriesdarwin_options_by_prefix(prefix)
- Explore macOS options
Remember: You DON'T need Nix/NixOS installed! This tool runs anywhere Python runs.
# Run directly with uvx (no installation needed)
uvx mcp-nixos
# Or install globally
pip install mcp-nixos
uv pip install mcp-nixos
# Run without installing
nix run github:utensils/mcp-nixos
# Install to profile
nix profile install github:utensils/mcp-nixos
- Drastically less code - v1.0.0 removed thousands of lines, v1.0.1 made them async
- 100% functionality - Everything still works, now with more
await
- 0% cache corruption - Because we removed the cache entirely (still gone!)
- Stateless operation - No files to clean up (async doesn't change this)
- Direct API access - No abstraction nonsense (but now it's async nonsense)
- Modern MCP - FastMCP 2.x because the old MCP was too synchronous
- Real-time data - Always current, never stale
- Plain text output - Human and AI readable
- Smart suggestions - Helps when you typo option names
- Cross-platform - Works on Linux, macOS, and yes, even Windows
- No configuration - It just worksβ’
- Dynamic channel resolution -
stable
always points to current stable - Enhanced error messages - Actually helpful when things go wrong
- Deduped flake results - No more duplicate spam
- Version-aware searches - Find that old Ruby version you need
- Category browsing - Explore options systematically
Want to test your changes in Claude Code or another MCP client? Create a .mcp.json
file in your project directory:
{
"mcpServers": {
"nixos": {
"type": "stdio",
"command": "uv",
"args": [
"run",
"--directory",
"/home/hackerman/Projects/mcp-nixos",
"mcp-nixos"
]
}
}
}
Replace /home/hackerman/Projects/mcp-nixos
with your actual project path (yes, even you, Windows users with your C:\Users\CoolDev\...
paths).
This .mcp.json
file:
- Automatically activates when you launch Claude Code from the project directory
- Uses your local code instead of the installed package
- Enables real-time testing - just restart Claude Code after changes
- Already in .gitignore so you won't accidentally commit your path
nix develop
menu # Shows all available commands
# Common tasks
run # Start the server (now with FastMCP!)
run-tests # Run all tests (now async!)
lint # Format and check code (ruff replaced black/flake8)
typecheck # Check types (mypy still judges you)
build # Build the package
publish # Upload to PyPI (requires credentials)
# Install development dependencies
uv pip install -e ".[dev]" # or pip install -e ".[dev]"
# Run the server locally
uv run mcp-nixos # or python -m mcp_nixos.server
# Development commands
pytest tests/ # Now with asyncio goodness
ruff format mcp_nixos/ # black is so 2023
ruff check mcp_nixos/ # flake8 is for boomers
mypy mcp_nixos/ # Still pedantic as ever
# Build and publish
python -m build # Build distributions
twine upload dist/* # Upload to PyPI
- 367 tests that actually test things (now async because why not)
- Real API calls because mocks are for cowards (await real_courage())
- Plain text validation ensuring no XML leaks through
- Cross-platform tests because Windows users deserve pain too
- 15 test files down from 29 because organization is a virtue
Just one. We're minimalists now:
Variable | Description | Default |
---|---|---|
ELASTICSEARCH_URL |
NixOS API endpoint | https://search.nixos.org/backend |
If you encounter this error when running via Nix:
error: derivation '/nix/store/...-python3.11-watchfiles-1.0.4.drv' specifies a sandbox profile,
but this is only allowed when 'sandbox' is 'relaxed'
Solution: Run with relaxed sandbox mode:
nix run --option sandbox relaxed github:utensils/mcp-nixos --
Why this happens: The watchfiles
package (a transitive dependency via MCP) requires custom sandbox permissions for file system monitoring. This is only allowed when Nix's sandbox is in 'relaxed' mode instead of the default 'strict' mode.
Permanent fix: Add to your /etc/nix/nix.conf
:
sandbox = relaxed
This project queries data from several amazing services:
- NixHub.io - Provides package version history and commit tracking
- search.nixos.org - Official NixOS package and option search
- Jetify - Creators of Devbox and NixHub
Note: These services have not endorsed this tool. We're just grateful API consumers.
MIT - Because sharing is caring, even if the code hurts.
Created by James Brink and maintained by masochists who enjoy Nix and async/await patterns.
Special thanks to the NixOS project for creating an OS that's simultaneously the best and worst thing ever.