MCP Servers Nix

🚀 MCP 服務器配置指南

本指南詳細介紹了 MCP 服務器的安裝、配置、擴展、自定義、測試、問題排查等內容，幫助你快速搭建和管理 MCP 服務器。

🚀 快速開始

安裝與基本配置

使用 flakes 的安裝方式

git clone https://github.com/yourusername/mcp-servers-nix.git
cd mcp-servers-nix
nix flake add . nixpkgs

不使用 flakes 的安裝方式

git clone https://github.com/yourusername/mcp-servers-nix.git
cd mcp-servers-nix
nix-env -f . -i mcp-servers-nix

📦 安裝指南

配置示例

默認配置

{
  mcp-servers.lib.mkConfig pkgs {
    programs = {
      filesystem = {
        enable = true;
        args = [ "/path/to/allowed/directory" ];
      };
    };
  };
}

自定義配置

mcp-servers-nix.mcp-servers.lib.mkConfig pkgs {
  format = "yaml";
  fileName = "config.yaml";

  programs = {
    filesystem = {
      enable = true;
      args = [ "/path/to/allowed/directory" ];
    };
  };

  settings.servers = {
    custom-server = {
      command = "${pkgs.lib.getExe pkgs.nodejs "npx"}";
      args = [
        "-y"
        "custom-server-package"
        "/path/to/custom/server/path"
      ];
    };
  };
}

🔧 技術細節

擴展框架

添加新服務器包

• 官方包：放置在 pkgs/official/ 目錄下。
• 參考實現：放置在 pkgs/reference/ 目錄下。
• 社區實現：放置在 pkgs/community/ 目錄下。

示例：添加新官方服務器包

創建一個新的包定義文件 pkgs/official/new-mcp-server/default.nix：

{
  lib,
  fetchFromGitHub,
  buildNpmPackage,
}:

buildNpmPackage rec {
  pname = "new-mcp-server";
  version = "0.1.0";

  src = fetchFromGitHub {
    owner = "new-mcp-server";
    repo = "new-mcp-server";
    tag = "v${version}";
    hash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA";
  };

  npmDepsHash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA";

  meta = {
    description = "New MCP server";
    homepage = "https://github.com/new-mcp-server/new-mcp-server";
    license = lib.licenses.asl20;
    maintainers = with lib.maintainers; [ username ];
    mainProgram = "new-mcp-server";
  };
}

然後在 pkgs/default.nix 中註冊：

{
  # ... 已經存在的包 ...
  
  new-mcp-server = pkgs.callPackage ./official/new-mcp-server { };
}

模塊配置

創建一個新的模塊文件 modules/new-mcp-server.nix：

{ mkServerModule, ... }:
{
  imports = [
    (mkServerModule {
      name = "new-mcp-server";
      packageName = "new-mcp-server";
    })
  ];
}

自定義模塊選項

定義自定義選項

在 modules/new-mcp-server.nix 中添加：

{ config, pkgs, lib, mkServerModule, ... }:
let
  cfg = config.programs.new-mcp-server;
in
{
  imports = [
    (mkServerModule {
      name = "new-mcp-server";
      packageName = "new-mcp-server";
    })
  ];

  configuration = {
    options = {
      customOption ?= {
        type = "string";
        description = "A custom option for the new mcp server";
      };
    };

    content = {
      programs.new-mcp-server.enable = cfg.enable;
      programs.new-mcp-server.customOption = cfg.customOption;
    };
  };
}

💻 使用示例

測試與驗證

使用 flakes 進行測試

nix flake test .

不使用 flakes 的測試方式

nix-shell --pure -E 'let { nixpkgs ?= import (fetchTarball "https://github.com/nix-community/interpreters/archive/master.tar.gz") {}; }' -I nixpkgs=. --run 'your-test-command'

問題排查

常見問題

• 依賴缺失：檢查 pkgs/default.nix 中的依賴是否正確。
• 配置錯誤：確保在 configuration.nix 或 flake.nix 中正確導入模塊。

📚 詳細文檔

貢獻指南

歡迎提交 Pull Request！

• 代碼倉庫：GitHub

📄 許可證

本項目遵循 MIT 協議。