article
README
🚀 新南威尔士州实时警报 MCP 服务器
这是一个模型上下文协议(Model Context Protocol)服务器,专为 Transport for NSW(TfNSW)的实时警报 API 打造。它提供了一系列工具,能让用户访问并交互获取实时交通警报和信息,还借助大型语言模型来实现相关功能。
🚀 快速开始
此基于 TypeScript 的语言服务器实现了与新南威尔士州运输局实时警报系统的集成。借助它,AI 助手可以访问最新的交通中断、计划中的工程以及其他重要的交通网络警报信息。
✨ 主要特性
资源
- 可列出并通过
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 文件。
扫码联系在线客服