Synchro Bus MCP Server

by unixfox

258 downloads
Not rated
GitHub

Description

# 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…

About

# 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…

Details

Author
unixfox
Downloads
258
Categories
Other

- Get network information for Synchro Bus
- Retrieve all lines and line details
- Access stop areas for specific lines
- Fetch schedules for stop areas
- Get current network disruptions
- Retrieve vehicle journey directions

Clone the repository, install dependencies with npm install, configure the base URL in a .env file, build with npm run build, and start with npm start. For development, use npm run dev for auto-reload.

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 information
- linesGet: Get all lines for a network
- lineGet: Get information about a specific line
- lineStopAreasGet: Get stop areas for a line
- lineStopAreaSchedulesGet: Get schedules for a stop area on a line
- disruptionsGet: Get disruptions for a network
- vehicleJourneysDirectionsGet: Get vehicle journey directions for a line

Installation

1. Clone the repository
2. Install dependencies:

   npm install

3. Copy the example environment file and update it with your settings:
   cp .env.example .env

4. 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 project
- npm run dev - Start the server in development mode with auto-reload
- npm run lint - Run ESLint
- npm run format - Format code with Prettier

License

MIT

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.