Synchro Bus MCP Server

🚀 同步總線 MCP 服務器

這是一個用於訪問 Instant-System API 的模型上下文協議 (MCP) 服務器。該服務器能讓你訪問 Instant-System API v3 的多個端點，尤其針對 ID 為 3 的 Synchro Bus 網絡，為你提供便捷的網絡信息查詢服務。

🚀 快速開始

本服務器可讓你輕鬆訪問 Instant-System API v3 的多個端點，特別是針對 ID 為 3 的 Synchro Bus 網絡。你可以按照以下步驟啟動服務器：

# 克隆倉庫
git clone <倉庫地址>
# 安裝依賴
npm install
# 複製示例環境文件並更新設置
cp .env.example .env
# 構建項目
npm run build
# 啟動服務器
npm start

✨ 主要特性

該服務器公開了以下 API 端點，滿足你對 Synchro Bus 網絡信息的各種查詢需求：

• networkGet：獲取網絡信息
• linesGet：獲取網絡中的所有線路
• lineGet：獲取特定線路的詳細信息
• lineStopAreasGet：獲取特定線路的所有停靠區域
• lineStopAreaSchedulesGet：獲取特定停靠區域內線路的時刻表
• disruptionsGet：獲取網絡中的當前中斷情況
• vehicleJourneysDirectionsGet：獲取特定線路車輛行程的方向

📦 安裝指南

1. 克隆倉庫：將項目倉庫克隆到本地。
2. 安裝依賴：

   npm install
   

3. 複製示例環境文件並更新設置：

   cp .env.example .env
   

4. 構建項目：

   npm run build
   

📚 詳細文檔

配置

在根目錄中創建一個 .env 文件，並添加以下變量：

INSTANT_SYSTEM_BASE_URL=https://prod.instant-system.com/InstantCore

使用

• 啟動服務器：

  npm start
  

• 使用開發模式（帶自動重載）：

  npm run dev
  

API 參考

• networkGet：獲取 Synchro Bus 網絡的信息。
• linesGet：獲取網絡中的所有線路。
• lineGet：獲取特定線路的詳細信息。
• lineStopAreasGet：獲取特定線路的所有停靠區域。
• lineStopAreaSchedulesGet：獲取特定停靠區域內線路的時刻表。
• disruptionsGet：獲取當前網絡中的中斷情況。
• vehicleJourneysDirectionsGet：獲取特定線路車輛行程的方向。

開發

• npm run build：構建項目
• npm run dev：以開發模式啟動服務器，帶自動重載功能
• npm run lint：運行 ESLint
• npm run format：使用 Prettier 格式化代碼

📄 許可證

本項目採用 MIT 許可證。