synchro-bus-mcp-server
The Synchro Bus MCP Server allows users to access the Synchro Bus API via a Model Context Protocol. It provides endpoints for retrieving bus network information, line details, and disruptions.
Synchro Bus MCP Server
A Model Context Protocol server for accessing the Synchro Bus (Instant-System) API. This server provides access to various endpoints of the Instant-System API v3, specifically for the Synchro Bus network (ID: 3).
Features
The server exposes the following API endpoints:
networkGet
: Get network informationlinesGet
: Get all lines for a networklineGet
: Get information about a specific linelineStopAreasGet
: Get stop areas for a linelineStopAreaSchedulesGet
: Get schedules for a stop area on a linedisruptionsGet
: Get disruptions for a networkvehicleJourneysDirectionsGet
: Get vehicle journey directions for a line
Installation
- Clone the repository
- Install dependencies:
npm install
- Copy the example environment file and update it with your settings:
cp .env.example .env
- Build the project:
npm run build
Configuration
Create a .env
file in the root directory with the following variables:
INSTANT_SYSTEM_BASE_URL=https://prod.instant-system.com/InstantCore
Usage
Start the server:
npm start
For development with auto-reload:
npm run dev
API Reference
networkGet
Get information about the Synchro Bus network.
linesGet
Get all lines available in the network.
lineGet
Get detailed information about a specific line.
lineStopAreasGet
Get all stop areas for a specific line.
lineStopAreaSchedulesGet
Get schedules for a specific stop area on a line.
disruptionsGet
Get current disruptions in the network.
vehicleJourneysDirectionsGet
Get available directions for vehicle journeys on a line.
Development
npm run build
- Build the projectnpm run dev
- Start the server in development mode with auto-reloadnpm run lint
- Run ESLintnpm run format
- Format code with Prettier
License
MIT