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"
      ];
    };
  };
}

📚 ドキュメント

拡張フレームワーク

新しいサーバーパッケージの追加

1. 公式パッケージ：pkgs/official/ ディレクトリに配置します。
2. 参考実装：pkgs/reference/ ディレクトリに配置します。
3. コミュニティ実装：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 ライセンスに従います。