Stevennevins MCP Server Template

🚀 MCP サーバーテンプレート

このテンプレートは、Model Context Protocol (MCP) 互換のサーバーを構築するための TypeScript テンプレートです。完全なツールサポート、型安全、およびベストプラクティスを備え、MCP サーバーの作成に堅固な基盤を提供します。

✨ 主な機能

• 🚀 完全な TypeScript サポート
• 🏗️ コンテナベースの依存性注入
• 📦 サービス指向アーキテクチャ、DataProcessor インターフェース付き
• 🛠️ ツール実装のサンプルとテスト
• 🧪 Vitest テストフレームワークの統合
• 📝 型定義ファイル
• 🔌 MCP SDK の統合

🚀 クイックスタート

開発手順

1. 依存関係をインストールします：

   npm install
   

2. 開発サーバーを起動します（ホットリロード付き）：

   npm run dev
   

3. プロジェクトをビルドします：

   npm run build
   

4. テストを実行します：

   npm test
   

5. 本番サーバーを起動します：

   npm start
   

📚 ドキュメント

プロジェクト構造

src/
├── index.ts          # エントリーファイル
├── interfaces/       # インターフェース定義
│   └── tool.ts      # DataProcessor インターフェース
└── tools/           # ツール実装
    └── example.ts   # サンプルツール

ツールの作成

1. src/tools/example.ts の例に従って、あなたのツールとハンドラーをエクスポートします：

   // your-tool.ts ファイル内
   export const YOUR_TOOLS = [
     {
       name: "your-tool-name",
       description: "Your tool description",
       parameters: {
         // あなたのツールのパラメーターパターン
       },
     },
   ];
   
   export const YOUR_HANDLERS = {
     "your-tool-name": async (request) => {
       // あなたのツールハンドラーの実装
       return {
         toolResult: {
           content: [{ type: "text", text: "Result" }],
         },
       };
     },
   };
   

2. src/index.ts であなたのツールを登録します：

   // src/index.ts ファイル内
   import { YOUR_TOOLS, YOUR_HANDLERS } from "./tools/your-tool.js";
   
   // すべてのツールをマージします
   const ALL_TOOLS = [...EXAMPLE_TOOLS, ...YOUR_TOOLS];
   const ALL_HANDLERS = { ...EXAMPLE_HANDLERS, ...YOUR_HANDLERS };
   

サーバーは自動的に以下のことを行います：

• あなたのツールを利用可能なツールとしてリストします
• 入力検証を処理します
• あなたのツールに対するリクエストを処理します
• MCP プロトコルに従ってレスポンスをフォーマットします

テスト

このテンプレートには、ローカルテスト用の TestClient と可視化デバッグ用の MCP Inspector が組み込まれています。

TestClient の使用

TestClient は、あなたのツールを簡単にテストする方法を提供します：

import { TestClient } from "./utils/TestClient";

describe("YourTool", () => {
  const client = new TestClient();

  it("should process data correctly", async () => {
    await client.assertToolCall(
      "your-tool-name",
      { input: "test" },
      (result) => {
        expect(result.toolResult.content).toBeDefined();
      }
    );
  });
});

MCP Inspector の使用

このテンプレートには、あなたのツールを可視化デバッグするための MCP Inspector が含まれています：

1. inspector を起動します：

   npx @modelcontextprotocol/inspector node dist/index.js
   

2. inspector UI を開きます：http://localhost:5173 Inspector は以下を提供します：

• ツールをテストするための可視化インターフェース
• リアルタイムのリクエスト/レスポンスモニタリング
• ツールのメタデータの検査
• インタラクティブなテスト環境

Cursor を使用したローカルテスト

Cursor を使用して MCP サーバーをローカルでテストするには：

1. パッケージをビルドしてリンクします：

   npm run build
   npm run link
   

2. バイナリファイルが正常に動作することを確認します：

   npx example-mcp-tool
   

3. Cursor でサーバーを追加します：
   • Cursor の設定を開きます
   • 機能タブに移動します
   • 下部の MCP サーバーセクションまでスクロールします
   • 「サーバーを追加」をクリックします
   • 「コマンド」タイプを選択します
   • 名前を入力します（例：「ローカルサンプルツール」）
   • コマンドを入力します：npx example-mcp-tool
   • 確認をクリックします
4. Cursor の MCP サーバーセクションで、サーバーが実行中と表示されていることを確認します。

注意：コードを変更した場合は、必ず再ビルドして再リンクしてください：

npm run build
npm run link

⚠️ 重要提示

• すべての依存関係が正しくインストールされていることを確認してください。
• 本番環境で使用する前に、十分なテストを行ってください。
• 詳細な情報は、MCP ドキュメントを参照してください。