Tfnsw Realtime Alerts MCP Server

🚀 新南威尔士州实时警报 MCP 服务器

本项目是一个模型上下文协议（Model Context Protocol）服务器，专为新南威尔士州运输局（Transport for NSW，简称TfNSW）的实时警报 API 打造。借助大型语言模型，该服务器提供了一系列工具，可用于访问和交互获取实时交通警报与信息，为用户及时掌握交通动态提供有力支持。

🚀 快速开始

此基于 TypeScript 的语言服务器实现了与新南威尔士州运输局实时警报系统的集成，能让 AI 助手访问最新的交通中断、计划中的工程和其他重要的交通网络警报信息。

若要与 Claude Desktop 一同使用，请添加服务器配置：

• 在 MacOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
• 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

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

请将"your_api_key_here"替换为从 TfNSW 开放数据平台 获取的 API 密钥。

✨ 主要特性

资源

• 可列出并通过nsw-transport:// URI 访问交通警报。
• 支持按交通方式（公交、火车、渡轮等）过滤警报。
• 以纯文本格式输出，方便 AI 助手消费。

工具

• get-transport-alerts - 获取当前的运输警报：
  • 支持按交通方式过滤。
  • 返回格式化的警报信息，涵盖受影响路线、时间范围和影响细节。

提示

• transport-disruption-summary - 生成当前交通警报的摘要：
  • 包含相关警报详细信息作为嵌入资源。
  • 返回结构化提示，供大语言模型（LLM）总结主要中断情况。

🚇 交通方式

支持以下交通方式：

• all - 所有交通方式
• buses - 悉尼地铁和外围地铁公交服务
• ferries - 悉尼渡轮和纽卡斯尔运输渡轮
• lightrail - 轻轨服务
• metro - 悉尼地铁
• nswtrains - NSW 火车区域列车和客车
• regionbuses - 区域公交服务
• sydneytrains - 悉尼火车郊区和城际网络

🔑 认证

此服务器需要与 TfNSW 开放数据 API 进行身份验证。您需在 TfNSW 开放数据平台 注册以获取 API 密钥。

📦 安装指南

与 Claude Desktop 集成

在相应系统的配置文件中添加服务器配置，具体路径如下：

• 在 MacOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
• 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

配置内容如下：

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

请将"your_api_key_here"替换为从 TfNSW 开放数据平台 获取的 API 密钥。

🔧 技术细节

开发环境配置

在开发过程中，需要在.env文件中配置 API 密钥：

NSW_TRANSPORT_API_KEY="your_api_key_here"

依赖安装

安装项目所需的依赖项：

npm install

服务器构建

构建服务器：

npm run build

功能开发（带自动重建）

在开发过程中，可使用以下命令实现自动重建：

npm run watch

调试

您可以使用 MCP Inspector 进行调试，该工具作为包脚本提供：

npm run inspector

Inspector 会提供一个访问浏览器调试工具的 URL。

📄 许可证

此项目在 MIT License 下许可，详细信息请参阅 LICENSE 文件。