Frequently Asked Questions (FAQ) about the Transport NSW API Client MCP Implementation

Q: What is MCP? A: MCP stands for Model Context Protocol. It’s an open protocol that standardizes how applications provide context to LLMs, enabling AI models to access external data sources and tools in a consistent manner.

Q: What is the Transport NSW API Client? A: It’s an open-source implementation of the Claude Model Context Protocol (MCP) specifically designed to interact with the Transport NSW API, providing real-time transport data access.

Q: What APIs are included in this client? A: The client includes the Stop Finder API (find stops by name/coordinates), Alerts API (get transport alerts and disruptions), and Departure Monitor API (get real-time departure information).

Q: How do I set up the Transport NSW API Client? A: Clone the repository, install dependencies using uv, create a .env file with your API key, and optionally run the MCP Inspector for development.

Q: Where do I get the Transport NSW API key? A: You need to register with Transport NSW’s developer portal to obtain an API key. Instructions for this can be found on their official website.

Q: What is UBOS? A: UBOS is a full-stack AI Agent Development Platform designed to help businesses orchestrate AI Agents, connect them with enterprise data, build custom AI Agents with LLM models, and create Multi-Agent Systems.

Q: How does the Transport NSW API Client integrate with UBOS? A: As an MCP implementation, it seamlessly integrates with UBOS, allowing AI agents within the UBOS ecosystem to easily access and utilize Transport NSW data.

Q: What are some use cases for this API client? A: Use cases include intelligent transport management, personalized travel planning, predictive maintenance, enhanced customer service, and smart city initiatives.

Q: What is uv? A: uv is a modern, fast Python package manager written in Rust, used for installing and managing project dependencies.

Q: How do I run the tests? A: Use the command uv run pytest to run the complete test suite. For coverage reporting, use uv run pytest --cov=api.

Q: Is there Continuous Integration (CI) setup? A: Yes, tests automatically run on GitHub Actions for every push and pull request to the main branch.

Q: Where can I find usage examples? A: Usage examples for each API (Stop Finder, Alerts, Departure Monitor) are provided in the project’s README file and demo script.

Q: What if I encounter issues or have questions? A: Please submit an issue on the project’s GitHub repository. We welcome contributions and feedback!