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 许可证。