TfNSW Realtime Alerts

A Model Context Protocol (MCP) server for TfNSW's realtime alerts API

javascript

7

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "piddlingtuna-tfnsw-realtime-alerts-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "tfnsw-realtime-alerts-mcp-server"
      ],
      "env": {
        "NSW_TRANSPORT_API_KEY": "your_api_key_here"
      }
    }
  }
}

You can access up-to-date TfNSW transport alerts through this MCP server, enabling AI assistants to understand disruptions, planned works, and other critical information across the NSW network. It exposes a simple way to retrieve alerts, filter by transport mode, and present plain text results for reliable AI consumption.

How to use

You interact with the server through MCP clients to fetch current transport alerts and generate concise summaries. Use the get-transport-alerts tool to retrieve alerts, optionally filtering by transport mode (buses, trains, ferries, etc.). Alerts are returned in plain text for easy processing by AI assistants, and you can reference individual alerts via nsw-transport:// URIs.

How to install

Prerequisites: ensure Node.js is installed on your machine. You will also need npm to install dependencies and run build tasks.

Install dependencies
Build the server
Run in development or start mode as needed

To configure authentication for the TfNSW Open Data API, you will provide an API key in an environment variable shown below.

{
  "mcpServers": {
    "tfnsw_realtime_alerts": {
      "command": "npx",
      "args": [
        "-y",
        "tfnsw-realtime-alerts-mcp-server"
      ],
      "env": {
        "NSW_TRANSPORT_API_KEY": "your_api_key_here"
      }
    }
  }
}

Additional notes

The server requires authentication with the TfNSW Open Data API. Register for an API key at the TfNSW Open Data Hub and supply it in the NSW_TRANSPORT_API_KEY environment variable.

Available tools

get-transport-alerts

Retrieve current transport alerts with optional transport mode filtering; returns formatted alert details including affected routes, time periods, and impact details.

transport-disruption-summary

Generate a structured summary of current transport alerts suitable for LLM summarisation, including embedded alert resources.