Generic MCP Server Template

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

このテンプレートは、モジュール化された拡張可能なモデルコンテキストプロトコル（MCP）サーバー用で、簡単なカスタマイズと拡張を実現することを目的としています。

✨ 主な機能

• モジュール化アーキテクチャ：問題の明確な分離と明確な構造
• 小型で集中的なファイル：より良い保守性とAIによる取得の容易さ
• 簡単な拡張ポイント：新しいツールやサービスを追加するための簡単なパターン
• 包括的なエラー処理：コード全体で強力なエラー管理
• 型安全：適切な型付けを持つ完全なTypeScriptサポート

📚 プロジェクト構造

generic-mcp-template/
├── src/
│   ├── services/       # API とのやり取りに使用するサービスクラス
│   │   ├── base-service.ts        # 汎用機能を持つ抽象ベースサービス
│   │   └── example-service.ts     # サービスの実装例
│   ├── tools/          # MCP ツールの定義とハンドラー
│   │   ├── example-tools.ts       # ツールの定義（名前、説明、パターン）
│   │   └── example-tool-handlers.ts # ツールハンドラーの実装
│   ├── types/          # TypeScript の型定義
│   │   └── example-types.ts       # 型定義の例
│   ├── config.ts       # 設定管理
│   └── index.ts        # メインエントリポイント
├── .env.example        # 環境変数の例
├── package.json        # プロジェクトの依存関係とスクリプト
├── tsconfig.json       # TypeScript の設定
└── README.md           # プロジェクトのドキュメント

🚀 クイックスタート

前提条件

• Node.js 18 以上
• npm または yarn

📦 インストール

1. このリポジトリをクローンします：

   git clone https://github.com/v4lheru/generic-mcp-template.git
   cd generic-mcp-template
   

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

   npm install
   

3. .env.example を元に .env ファイルを作成します：

   cp .env.example .env
   

4. .env ファイルを編集し、独自のAPIキーと設定を入力します。

ビルドと実行

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

   npm run build
   

2. サーバーを起動します：

   npm start
   

💻 使用例

新しいサービスの追加

1. src/services/ ディレクトリに新しいサービスファイルを作成します：

   // src/services/my-service.ts
   import { BaseService } from './base-service.js';
   import config from '../config.js';
   
   export class MyService extends BaseService {
       // サービスを実装します...
   }
   

2. src/types/ ディレクトリに必要な型を追加します。

新しいツールの追加

1. src/tools/ ディレクトリでツールを定義するか、既存のファイルを拡張します：

   // src/tools/my-tools.ts
   export const myTools = [
       {
           name: "my_tool",
           description: "私のツールの説明",
           inputSchema: {
               // ツール入力のJSONスキーマ
           }
       }
   ];
   

2. ツールハンドラーを実装します：

   // src/tools/my-tool-handlers.ts
   import { MyService } from '../services/my-service.js';
   
   export function createMyToolHandlers(myService: MyService) {
       return {
           my_tool: async (args: any) => {
               // ツールハンドラーを実装します
           }
       };
   }
   

3. src/index.ts でツールとハンドラーを登録します。

🔧 技術詳細

設定

テンプレートは src/config.ts で集中的な設定システムを使用しています。設定は以下の方法で提供できます：

• 環境変数
• コマンドライン引数（--env KEY=VALUE で）
• コード内のデフォルト値

エラー処理

テンプレートには包括的なエラー処理が含まれています：

• サービスレベルのエラー処理で、レート制限サポート付き
• ツールレベルのエラー処理で、正しいエラーメッセージ付き
• MCP プロトコルのエラー処理

📄 ライセンス

MIT