MCP Template Node

🚀 MCP テンプレートノード

このテンプレートは、Model Context Protocol (MCP) サーバーを作成するための Node.js/TypeScript テンプレートです。簡単なノート管理システムを MCP プロトコルを使用して実装しています。

🚀 クイックスタート

クローンと依存関係のインストール

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

git clone https://github.com/Rethunk-Tech/mcp-template-node.git
cd mcp-template-node

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

yarn install

3. サーバーをビルドして起動します：

yarn build
yarn start

✨ 主な機能

• 厳格な型チェックを行う TypeScript で実装
• 基本的な CRUD 操作を備えたシンプルなノート管理システム
• MCP 概念の完全な例（ツール、リソース、プロンプト）
• ノートをメモリに保存
• 包括的なエラー処理と検証
• Vitest を使用した単体テスト
• VS Code のデバッグ設定
• テストとビルド用の GitHub Actions CI ワークフロー

📦 インストール

前提条件

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

📚 ドキュメント

何が MCP ですか？

Model Context Protocol (MCP) は、アプリケーションが大規模言語モデル（LLMs）にコンテキストを提供するための標準化された方法です。詳細は MCP プロトコル公式サイト を参照してください。

プロジェクト構造

mcp-template-node/
├── build/                # コンパイル後の JavaScript ファイル
├── src/
│   ├── __tests__/        # 統合テストとテストツール
│   ├── errors/           # カスタムエラークラス
│   ├── tools/            # MCP ツールの実装
│   │   └── __tests__/    # ツールの単体テスト
│   ├── types/            # TypeScript の型定義
│   │   └── __tests__/    # 型のテスト
│   └── index.ts          # サーバーのメインエントリーファイル、MCP の例付き
├── package.json          # プロジェクト設定
├── tsconfig.json         # TypeScript 設定
├── eslint.config.mjs     # ESLint の平面設定
└── README.md             # プロジェクトドキュメント

開発

• TypeScript コンパイラのリアルタイムモードを起動：yarn dev
• コードフォーマットをチェック：yarn lint
• フォーマット問題を修正：yarn lint:fix
• テストを実行：yarn test

テスト

このプロジェクトには、MCP サーバーとそのツールの機能を検証するための包括的なテストが含まれています。

テストの実行

• すべてのテストを実行：

yarn test

• ウォッチモードでテストを実行（ファイル変更時に再実行）：

yarn test:watch

• カバレッジを含めてテストを実行：

yarn test:coverage

テスト構造

• 単体テスト：__tests__ フォルダ内にあり、注釈付きの例があります。
• 統合テスト：src/__tests__/integration フォルダ内にあります。
• カバレッジレポート：coverage フォルダに生成されます。

テンプレートの拡張

このテンプレートを拡張するには、以下の手順を実行します。

1. プロジェクトのルートディレクトリに config.ts ファイルを作成し、以下の内容を定義します。

export interface Config {
  environment: 'development' | 'production';
  port: number;
  apiPrefix: string;
}

export const config: Config = {
  environment: process.env.NODE_ENV || 'development',
  port: parseInt(process.env.PORT) || 3000,
  apiPrefix: '/api'
};

2. src/tools フォルダ内にカスタムツールを作成します。

貢献ガイド

このプロジェクトに貢献するには、以下の手順に従ってください。

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更をコミットします。
4. 個人のリポジトリにプッシュします。
5. プルリクエストを送信します。

📄 ライセンス

[ここにライセンス情報を追加]

🔗 コンタクト

• メール：[ここにメールアドレスを追加]
• GitHub：[ここに GitHub ユーザー名またはリンクを追加]