Hello World MCP Server

Hello World MCP Server

Hello World MCP Serverへようこそ！このプロジェクトでは、Model Context Protocol (MCP) SDK を使用してサーバーをセットアップする方法を紹介します。ツール、プロンプト、サーバー送信イベント（SSE）とメッセージを処理するエンドポイントが含まれています。

このプロジェクトは、ブログ記事Building a TypeScript MCP Server: A Guide for Integrating Existing Servicesの一部です。ブログでは、このプロジェクトの背景にある概念や実装の詳細について解説しています。

---

機能

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

---

前提条件

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

1. Node.js（v16 以降）- こちらからダウンロード
2. npm（Node.js に付属）または yarn

---

はじめに

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

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

---

サーバーをテストする

1. MCP Inspector を使用する

MCP Inspector は、MCP サーバーをテストおよび検査するためのツールです。これを使用して、ツールとプロンプトが正しく登録されているか確認できます。

以下のコマンドを実行して、サーバーを検査します。

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

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

---

プロジェクト構成

プロジェクトの構成の概要は次のとおりです。

hello-world-mcp-server/
├── src/
│   ├── server.ts                     # Main server entry point
│   ├── modules/
│   │   ├── tools.ts                  # Registers MCP tools
│   │   ├── prompts.ts                # Registers MCP prompts
│   │   └── transports.ts             # Handles SSE and message endpoints
├── .env                              # Environment variables
├── .env.example                      # Example environment variables
├── package.json                      # Project metadata and scripts
├── tsconfig.json                     # TypeScript configuration
└── README.md                         # Project documentation

---

トラブルシューティング

よくある問題

1. ポートがすでに使用中：ポートが使用中であるというエラーが表示された場合は、.env ファイルの PORT 変数を更新してください。
2. TypeScript エラー：すべての依存関係がインストールされ、正しいバージョンの Node.js を使用していることを確認してください。

デバッグ

以下のコマンドを使用して、サーバーをデバッグします。

npm run dev

ライブリロードと詳細なログを有効にしてサーバーが起動します。

---

関連プロジェクト

• Ollama Pydantic Project：このプロジェクトで開発したツールを利用する LLM エージェントを実装した、対になるプロジェクトです。詳しくは、ブログ記事Integrating MCP Server with a Local LLM Chatbotをご覧ください。

---

貢献

貢献を歓迎します！お気軽にイシューを作成するか、プルリクエストを送信してください。

---

ライセンス

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