Hello World MCP Server

🚀 こんにちは、世界MCPサーバー

このプロジェクトは、モデルコンテキストプロトコル（MCP） SDKを使用してサーバーを構築する方法をデモンストレーションします。ツール、プロンプト、およびサーバーサイドイベント（SSE）とメッセージを処理するエンドポイントが含まれています。

このプロジェクトは、このブログ記事の一部です：TypeScript MCPサーバーの構築：既存のサービスを統合するガイド。ブログを訪問して、プロジェクトの背後にある概念と実装の詳細を学ぶことができます。

🚀 クイックスタート

このプロジェクトをセットアップして実行するには、以下の手順に従ってください。

1. リポジトリをクローンする

まだクローンしていない場合は、リポジトリをローカルマシンにクローンします。

git clone https://github.com/your-username/hello-world-mcp-server.git
cd hello-world-mcp-server

2. 依存関係をインストールする

npmまたはyarnを使用して、必要な依存関係をインストールします。

npm install

または

yarn install

3. 環境変数を設定する

このプロジェクトでは、.envファイルを使用してサーバーのポートを設定します。.env.exampleというサンプルファイルが用意されています。

1. .env.exampleを.envにコピーします。

cp .env.example .env

2. .envファイルを開き、必要に応じてPORT変数を更新します。デフォルトは4000です。

PORT=4000

4. プロジェクトをビルドする

TypeScriptコードをJavaScriptにコンパイルします。

npm run build

これにより、distディレクトリにコンパイルされたファイルが生成されます。

5. サーバーを起動する

本番モードでサーバーを起動します。

npm start

または、開発モード（リアルタイムリロード付き）で起動することもできます。

npm run dev

✨ 主な機能

• MCP統合：MCP SDKを使用して、ツールとプロンプト付きのサーバーを作成します。
• Expressフレームワーク：SSEとメッセージ通信のためのHTTPエンドポイントを処理します。
• 環境設定：.envファイルを使用して簡単に設定できます。
• TypeScriptサポート：完全に型付けされたコードベースで、開発者体験を向上させます。

📦 インストール

始める前に、以下のものがインストールされていることを確認してください。

1. Node.js (v16以上) - ダウンロード
2. npm（Node.jsに付属）または yarn

📚 ドキュメント

サーバーのテスト

1. MCPインスペクターを使用する

MCPインスペクターは、MCPサーバーをテストおよび検査するツールです。登録されたツールとプロンプトが正しいかどうかを検証するために使用できます。 以下のコマンドを実行して、サーバーをチェックします。

npx @modelcontextprotocol/inspector ./dist/server.js

これにより、サーバーに登録されたツールとプロンプトをテストできるインタラクティブなインターフェイスが開きます。

プロジェクト構造

以下は、プロジェクトの概要構造です。

hello-world-mcp-server/
├── src/
│   ├── server.ts                     # メインサーバーファイル
│   ├── index.ts                      # エントリーポイント
│   └── routes/
│       └── exampleRoute.ts          # サンプルルート
├── .env                             # 環境変数設定
├── package.json                    # プロジェクトの依存関係とスクリプト
├── tsconfig.json                   # TypeScript設定
└── README.md                       # プロジェクト説明ドキュメント

貢献

貢献を歓迎します！自由に問題を提起したり、プルリクエストを送信したりしてください。

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細については、LICENSEファイルを参照してください。