Dart MCP Server Template

🚀 Dart MCP 服務器模板

Dart MCP 服務器模板是一個用於創建與 MCP（模型控制協議）兼容的 Dart 服務應用程序的工具。它提供了 Docker 配置、服務器實現和基本項目結構，為開發者搭建 MCP 服務器提供了便捷的起點。

📦 安裝指南

克隆此倉庫並手動更新包名：

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 目錄以開始 fresh
rm -rf .git

# 初始化新的 Git 倉庫
git init

然後更新 pubspec.yaml 和代碼庫中的包名。

✨ 主要特性

此模板包含以下內容：

• 使用標準 I/O、Server-Sent Events 和 HTTP 流式傳輸的可執行 Dart 服務器實現
• Docker 配置以實現輕鬆部署
• 基本項目結構，包括 lib、bin 和 test 目錄
• 與 mcp_dart 包的集成

📚 詳細文檔

項目結構和功能

服務器實現

• 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 客戶端和服務器。這裡 是一個端到端的示例。

開始使用

在從模板創建項目後：

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 流式）

Docker 部署

此模板包含一個 Dockerfile 以實現輕鬆容器化：

# 構建 Docker 映像
docker build -t my-mcp-server .

# 運行容器
docker run -p 3000:3000 my-mcp-server

📄 許可證

此模板在 MIT License 下發布。當您從這個模板生成自己的應用程序時，您可以自由選擇您的項目的許可；該模板不會強制對您的生成代碼施加特定許可證。