公交网络API服务器

一个用于访问Synchro Bus(Instant-System)API的模型上下文协议服务器,提供对Synchro Bus网络(ID: 3)的Instant-System API v3的各种端点的访问。

  • by unixfox
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 unixfox/synchro-bus-mcp-server

使用说明

同步总线MCP服务器

用于访问同步总线(即时系统)API的模型上下文协议服务器。该服务器提供对即时系统API v3的各种端点的访问,特别是对同步总线网络(ID:3)的访问。

特性

服务器公开以下API终结点:

  • 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参考

网络获取

获取有关Synchro总线网络的信息。

lines获取

获取网络中的所有可用线路。

lineGet

获取特定线路的详细信息。

lineStop区域获取

获取特定线路的所有停车区域。

lineStopAreaSchedules获取

获取线路上特定停车区域的时间表。

中断获取

获取网络中的当前中断。

车辆行程路线获取

获取线路上车辆行驶的可用路线。

发展

  • npm run build -构建项目
  • npm run dev -以自动重新加载的开发模式启动服务器
  • npm run lint -运行ESLint
  • npm run format -使用Prettier格式化代码

许可证

麻省理工学院