what is Synchro Bus MCP Server?
Synchro Bus MCP Server is a Model Context Protocol server designed to provide access to the Synchro Bus (Instant-System) API, specifically for the Synchro Bus network.
how to use Synchro Bus MCP Server?
To use the server, clone the repository, install the dependencies, configure the environment variables, and start the server using npm commands.
key features of Synchro Bus MCP Server?
- Access to various API endpoints for network information, lines, stop areas, schedules, disruptions, and vehicle journey directions.
- Easy installation and configuration process.
- Development mode with auto-reload functionality.
use cases of Synchro Bus MCP Server?
- Integrating real-time public transport data into applications.
- Monitoring disruptions and schedules for public transport systems.
- Developing tools for transport management and planning.
FAQ from Synchro Bus MCP Server?
- What is the purpose of this server?
It provides a way to access the Synchro Bus API for various transport-related data.
- How do I install the server?
Clone the repository, install dependencies, configure the environment, and start the server.
- Is there a license for this project?
Yes, it is licensed under the MIT license.
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
