MCP-NixOS logo

MCP-NixOS

by utensils

MCP-NixOS is a Model Context Protocol server that provides real-time access to NixOS, Home Manager, and nix-darwin resources. It prevents AI assistants from hallucinating information about these systems by providing accurate data.

View on GitHub

Last updated: N/A

What is MCP-NixOS?

MCP-NixOS is a Model Context Protocol (MCP) server designed to provide accurate information about NixOS packages, system options, Home Manager settings, and nix-darwin macOS configurations to AI assistants. It acts as a bridge between LLMs and these systems, preventing them from generating incorrect or outdated information.

How to use MCP-NixOS?

To use MCP-NixOS, you need to install it using pip, uv, or uvx and configure it in your MCP configuration file. Then, you can use MCP-compatible models and include MCP-NixOS resources in your prompts using the specified resource URLs (e.g., ~nixos://package/python). The LLM will fetch information through the MCP server.

Key features of MCP-NixOS

  • Provides access to NixOS packages and system options.

  • Supports Home Manager user configuration options.

  • Includes nix-darwin macOS configurations.

  • Implements smart caching to reduce network requests and improve startup time.

  • Offers rich search capabilities for finding relevant resources.

Use cases of MCP-NixOS

  • Enabling AI assistants to provide accurate information about NixOS packages and system options.

  • Assisting users in configuring NixOS, Home Manager, and nix-darwin systems.

  • Providing a reliable source of information for LLMs to generate documentation and tutorials about NixOS-related technologies.

  • Helping developers find and understand NixOS packages and system options.

FAQ from MCP-NixOS

What is Model Context Protocol (MCP)?

The Model Context Protocol (MCP) is an open protocol that connects LLMs to external data and tools using JSON messages over stdin/stdout.

What resources are available through MCP-NixOS?

MCP-NixOS provides access to NixOS packages, system options, Home Manager settings, and nix-darwin macOS configurations.

How do I install MCP-NixOS?

You can install MCP-NixOS using pip, uv, or uvx.

How do I configure MCP-NixOS?

Add the MCP-NixOS configuration to your MCP configuration file (e.g., ~/.config/claude/config.json).

What are the default cache locations?

The default cache locations are: Linux: ~/.cache/mcp_nixos/, macOS: ~/Library/Caches/mcp_nixos/, Windows: %LOCALAPPDATA%\mcp_nixos\Cache\.