Skip to main content

Model Context Protocol server for NixOS, Home Manager, and nix-darwin resources

Project description

MCP-NixOS - Because Your AI Assistant Shouldn't Hallucinate About Packages

CI codecov PyPI Python Versions smithery badge Verified on MseeP

🎉 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.

Quick Start (Because You Want to Use It NOW)

🚨 No Nix/NixOS Required! This tool works on any system - Windows, macOS, Linux. You're just querying web APIs.

Option 1: Using uvx (Recommended for most users)

{
  "mcpServers": {
    "nixos": {
      "command": "uvx",
      "args": ["mcp-nixos"]
    }
  }
}

Option 2: Using Nix (For Nix users)

{
  "mcpServers": {
    "nixos": {
      "command": "nix",
      "args": ["run", "github:utensils/mcp-nixos", "--"]
    }
  }
}

That's it. Your AI assistant now has access to real NixOS data instead of making things up. You're welcome.

What Is This Thing?

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)

The Tools You Actually Care About

🔍 NixOS Tools

  • nixos_search(query, type, channel) - Search packages, options, or programs
  • nixos_info(name, type, channel) - Get detailed info about packages/options
  • nixos_stats(channel) - Package and option counts
  • nixos_channels() - List all available channels
  • nixos_flakes_search(query) - Search community flakes
  • nixos_flakes_stats() - Flake ecosystem statistics

📦 Version History Tools (NEW!)

  • nixhub_package_versions(package, limit) - Get version history with commit hashes
  • nixhub_find_version(package, version) - Smart search for specific versions

🏠 Home Manager Tools

  • home_manager_search(query) - Search user config options
  • home_manager_info(name) - Get option details (with suggestions!)
  • home_manager_stats() - See what's available
  • home_manager_list_options() - Browse all 131 categories
  • home_manager_options_by_prefix(prefix) - Explore options by prefix

🍎 Darwin Tools

  • darwin_search(query) - Search macOS options
  • darwin_info(name) - Get option details
  • darwin_stats() - macOS configuration statistics
  • darwin_list_options() - Browse all 21 categories
  • darwin_options_by_prefix(prefix) - Explore macOS options

Installation Options

Remember: You DON'T need Nix/NixOS installed! This tool runs anywhere Python runs.

For Regular Humans (Windows/Mac/Linux)

# Run directly with uvx (no installation needed)
uvx mcp-nixos

# Or install globally
pip install mcp-nixos
uv pip install mcp-nixos

For Nix Users (You Know Who You Are)

# Run without installing
nix run github:utensils/mcp-nixos

# Install to profile
nix profile install github:utensils/mcp-nixos

Features Worth Mentioning

🚀 Version 1.0.0: The Great Simplification

  • Drastically less code - Removed thousands of lines of complexity
  • 100% functionality - Everything still works
  • 0% cache corruption - Because we removed the cache entirely
  • Stateless operation - No files to clean up
  • Direct API access - No abstraction nonsense

📊 What You Get

  • 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™

🎯 Key Improvements

  • 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

For Developers (The Brave Ones)

With Nix (The Blessed Path)

nix develop
menu  # Shows all available commands

# Common tasks
run        # Start the server
run-tests  # Run all tests
lint       # Format and check code
typecheck  # Check types

Without Nix (The Path of Pain)

pip install -e ".[dev]"
pytest tests/
black mcp_nixos/
flake8 mcp_nixos/

Testing Philosophy

  • 367 tests that actually test things
  • Real API calls because mocks are for cowards
  • Plain text validation ensuring no XML leaks through
  • Cross-platform tests because Windows users deserve pain too

Environment Variables

Just one. We're minimalists now:

Variable Description Default
ELASTICSEARCH_URL NixOS API endpoint https://search.nixos.org/backend

Acknowledgments

This project queries data from several amazing services:

Note: These services have not endorsed this tool. We're just grateful API consumers.

License

MIT - Because sharing is caring, even if the code hurts.


Created by James Brink and maintained by masochists who enjoy Nix.

Special thanks to the NixOS project for creating an OS that's simultaneously the best and worst thing ever.

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

mcp_nixos-1.0.0.tar.gz (948.1 kB view details)

Uploaded Source

Built Distribution

mcp_nixos-1.0.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_nixos-1.0.0.tar.gz.

File metadata

  • Download URL: mcp_nixos-1.0.0.tar.gz
  • Upload date:
  • Size: 948.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcp_nixos-1.0.0.tar.gz
Algorithm Hash digest
SHA256 630a3580b4f64b8f7be931c16cc6cf6cd0fe7fb9d2fc7e6a9c8b4e75e71b2090
MD5 4d638d3496d355b441a1377d11ff0dbe
BLAKE2b-256 a4d327a67d2dc17e384ed3d6866b0c966cb4a18a8cb00e6c3fee4ddfa4982e52

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_nixos-1.0.0.tar.gz:

Publisher: ci.yml on utensils/mcp-nixos

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_nixos-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mcp_nixos-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcp_nixos-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eef019383cf2e8dffb33880946994745563569ce79b4505353895da4cdf3246d
MD5 c225cd748b375c687dfad06eb5731cad
BLAKE2b-256 5ccde502abcbeb8f02b5097b243ed20c98adcd072531ca3499e39134613b2ee8

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_nixos-1.0.0-py3-none-any.whl:

Publisher: ci.yml on utensils/mcp-nixos

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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