Dart MCP Server Template

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

このテンプレートは、MCP（モデル制御プロトコル）と互換性のあるDartサービスアプリケーションを作成するためのものです。Docker設定、サーバー実装、基本的なプロジェクト構造を含み、開発の起点として利用できます。

🚀 クイックスタート

このテンプレートを使用することで、MCP互換のDartサーバーアプリケーションを迅速に構築できます。以下の手順に沿って進めることで、開発をスムーズに開始できます。

✨ 主な機能

• 標準I/O、Server-Sent Events、HTTPストリーミングを使用した実行可能なDartサーバー実装
• Docker設定による簡単なデプロイ
• lib、bin、testディレクトリを含む基本的なプロジェクト構造
• mcp_dartパッケージとの統合

📦 インストール

このテンプレートを使用するには、まずリポジトリをクローンし、パッケージ名を手動で更新します。

git clone https://github.com/jhgaylor/dart-mcp-server-template.git my_new_mcp_server
cd my_new_mcp_server

# コードベース内のパッケージ名を更新
find . -type f -name "*.dart" -o -name "pubspec.yaml" | xargs sed -i 's/dart_mcp_server_template/my_new_mcp_server/g'
# リポジトリURL内のパッケージ名を更新
find . -type f -name "*.md" -o -name "Dockerfile" | xargs sed -i 's/dart-mcp-server-template/my-new-mcp-server/g'
# ファイル名を変更
find . -type f -name "*dart_mcp_server_template*" | while read file; do mv "$file" "${file//dart_mcp_server_template/my_new_mcp_server}"; done

# 古い.gitディレクトリを削除して新しく開始
rm -rf .git

# 新しいGitリポジトリを初期化
git init

その後、pubspec.yaml とコードベース内のパッケージ名を更新します。

💻 使用例

基本的な使用法

テンプレートからプロジェクトを作成した後、以下の手順でサーバーを起動できます。

1. pubspec.yaml のプロジェクト詳細を更新します。
2. lib/src/config.dart の設定を必要に応じて変更します。
3. カスタムサーバーロジックを実装します。
4. 提供されているエントリポイントを使用してサーバーを実行します。
   • dart bin/stdio_server.dart（標準I/O）
   • dart bin/sse_server.dart（Server-Sent Events）
   • dart bin/streamable_http_server.dart（HTTPストリーミング）

高度な使用法

メモリ内でDartクライアントとサーバーを完全に接続するには、IOStreamTransport を使用できます。こちらにエンドツーエンドの例があります。

📚 ドキュメント

プロジェクト構造と機能

サーバー実装

• bin/ - 異なるトランスポート方法でサーバーを起動するための実行可能なDartファイルが含まれています。

  • dart bin/stdio_server.dart：標準I/Oトランスポートでサーバーを起動します。
  • dart bin/sse_server.dart：Server-Sent Eventsトランスポートでサーバーを起動します。
  • dart bin/streamable_http_server.dart：HTTPストリーミングでサーバーを起動します。
  • これらの実行可能ファイルはすべて、lib/src/server.dart で定義されたコアサーバー実装を使用しています。

• lib/src/server.dart - 基本的なMCPサーバーを設定します。ここに大部分のカスタムコードを記述します。

メモリストリームトランスポート

IOStreamTransport を使用すると、メモリ内でDartクライアントとサーバーを完全に接続できます。こちらにエンドツーエンドの例があります。

Dockerデプロイ

このテンプレートには、簡単なコンテナ化を実現するためのDockerfileが含まれています。

# Dockerイメージをビルド
docker build -t my-mcp-server .

# コンテナを実行
docker run -p 3000:3000 my-mcp-server

📄 ライセンス

このテンプレートはMITライセンスの下で公開されています。このテンプレートから独自のアプリケーションを生成する際には、プロジェクトのライセンスを自由に選択できます。このテンプレートは生成されたコードに特定のライセンスを強制しません。