Nix MCP Servers

🚀 Configure Your MCP Server with Nix

This project offers a unified interface to configure multiple MCP (Modular Configuration Protocol) clients, such as Claude Desktop and Cursor. Whether you're using NixOS, nix - darwin, or Home Manager, you can easily manage your MCP server settings through this project.

🚀 Quick Start

Install the CLI Tool

nix run github:aloshy-ai/nix-mcp-servers

Configure the MCP Server

Choose the appropriate configuration file to edit according to your platform:

For NixOS and nix - darwin

# NixOS
sudo nixos-rebuild test

# nix-darwin
darwin-rebuild test

For Home Manager

home-manager switch

Verify the Configuration

Check if the generated configuration file exists:

# For Claude Desktop on macOS
cat ~/Library/Application\ Support/Claude/mcp-config.json

# For Claude Desktop on Linux
cat ~/.config/claude-desktop/mcp-config.json

# For Cursor on macOS
cat ~/Library/Application\ Support/Cursor/mcp-config.json

# For Cursor on Linux
cat ~/.config/Cursor/mcp-config.json

You should see a JSON file containing the server information you configured.

✨ Features

Supported Platforms

• NixOS: Configure using nixos-rebuild
• nix-darwin: Configure using darwin-rebuild
• Home Manager: Configure using home-manager

Module Structure

The project uses a modular structure to handle configurations for different platforms:

• Common Options: Defines the core module options for servers and clients
• Platform Adapters: Implements specific configurations for NixOS, Darwin, and Home Manager
• Library Functions: Provides helper functions for path handling, platform detection, and configuration generation

Project Structure

The project uses flake-parts for modularity:

• modules/ - Contains modules for NixOS, Darwin, and Home Manager
  • common/ - Shared module definitions and options
  • nixos/ - NixOS-specific implementation
  • darwin/ - Darwin-specific implementation
  • home-manager/ - Home Manager implementation
• lib/ - Utility functions for modules
  • clients.nix - Handles client-specific configurations
  • servers.nix - Formats server configurations
  • platforms.nix - Platform detection and path utilities
  • paths.nix - Path operation functions
• docs/ - Documentation
  • examples/ - Usage examples
  • modules/ - Module documentation

📚 Documentation

• Module Options - Detailed documentation of all available options
• Usage Examples - Examples for different platforms
• Troubleshooting - Solutions to common problems

You can also directly generate and view the option documentation using the following command:

nix run github:aloshy-ai/nix-mcp-servers#view-docs

GitHub Pages Documentation

The project is configured to automatically build and deploy to GitHub Pages. The documentation is generated from the docs package and deployed when changes are pushed to the main branch. This method does not require manual configuration of the GitHub Pages environment.

The deployment is handled by the peaceiris/actions-gh-pages action, which creates a gh-pages branch containing the documentation.