Custom MCP Template

🚀 MCP サーバーテンプレート（create-mcp-server）

このテンプレートを使用すると、新しい Model Context Protocol (MCP) サーバープロジェクトを迅速に起動し、推奨される実践に基づいて構成することができます。

🚀 クイックスタート

新しいサーバーの作成

my-new-mcp-server という名前の新しい MCP サーバープロジェクトを作成するには、以下のコマンドを実行します。

npx create-mcp-server my-new-mcp-server

⚠️ 重要提示

このパッケージがまだ npm に公開されていない場合は、まずテンプレートディレクトリで npm link を実行し、create-mcp-server my-new-mcp-server を使用してください。

このコマンドを実行すると、以下の操作が行われます。

1. my-new-mcp-server という名前の新しいディレクトリが作成されます。
2. プロジェクトの詳細情報（名前、説明）の入力を求められます。
3. テンプレートファイル（src、docs、設定ファイルなど）が新しいディレクトリにコピーされます。
4. package.json があなたのプロジェクトの詳細情報で更新されます。

初期化が完了したら、ターミナルの指示に従って操作します。

cd my-new-mcp-server
npm install
# 設定は src/config/ConfigurationManager.ts で確認できます
# src/tools/ にあなたのツールを追加してください
# src/services/ にあなたのサービスを追加してください
npm run dev  # 開発サーバーを起動します

このテンプレートの開発（上級者向け）

このセクションでは、mcp-server-template そのもの の構造と開発フローについて説明します。このテンプレートを使用して自分のサーバーを作成するだけの場合は、通常この情報は必要ありません。

プロジェクト構造

• /src：すべてのソースコードが含まれています。
  • /config：設定管理（ConfigurationManager）。
  • /services：コアビジネスロジッククラス。
  • /tools：MCP ツールの定義とアダプター（*Tool.ts,*Params.ts）。
  • /types：TypeScript インターフェースと Zod スキーマ。
  • /utils：共有ユーティリティ関数（ログ記録、エラー処理など）。
  • initialize.ts：サーバーインスタンスの作成とツールの登録。
  • server.ts：アプリケーションのメインエントリポイント。
• /dist：コンパイルされた JavaScript 出力（npm run build で生成）。
• package.json：プロジェクトのメタデータと依存関係。
• sconfig.json：TypeScript コンパイラオプション。
• .eslintrc.json：ESLint 設定。
• .prettierrc.json：Prettier 設定。
• .gitignore：Git の無視ルール。

入門ガイド

1. 依存関係のインストール：

   npm install
   

2. Husky の設定（必要な場合、初回実行時）：

   npx husky install
   

3. 開発モードで実行： （s-node と odemon を使用して自動リロード）

   npm run dev
   

4. 本番用バージョンのビルド：

   npm run build
   

5. 本番用ビルドの実行：

   npm start
   

新しいツール（yourTool）の追加

1. 型の定義： src/types/yourServiceTypes.ts を作成し、インターフェース（例：YourServiceConfig, YourServiceData）を含めます。src/types/index.ts からエクスポートします。
2. サービスの実装： src/services/yourService.ts を作成し、必要に応じてサービスロジックを実装します。
3. ツールパラメータの定義： src/tools/yourToolParams.ts で型定義をエクスポートします。
4. ツールの登録： src/initialize.ts で tools 配列にあなたのツールを追加します。
5. 実行とテスト： npm run dev でサーバーを起動し、/api/your_tool にアクセスして新しいツールをテストします。

コードチェック

1. Linting（コードチェック）：

   npm run lint
   

2. Formatting（整形）：

   npm run format
   

これらのコマンドを使用すると、コードの整潔さと一貫性を維持することができます。