Skip to main content

A Model Context Protocol server that interfaces with Ireland's NTA API

Project description

NTA MCP Server

A Model Context Protocol server that interfaces with Ireland's National Transport Authority (NTA) API.

Available Tools

This package provides the following tools for interacting with the NTA API:

  • get_trip_updates

    • Retrieves real-time trip update information from the NTA API. This includes data about transit vehicle schedules, delays, and timing.
    • No input parameters required.
  • get_vehicles

    • Retrieves real-time vehicle position information from the NTA API. This includes current location data for transit vehicles.
    • No input parameters required.
  • get_gtfs_realtime

    • Retrieves the GTFS real-time feed from the NTA API. This includes comprehensive real-time transit data.
    • No input parameters required.

Prompts

  • "Get the current trip updates from Dublin Bus and show me buses that are running late."
  • "List all Dublin Bus route 46A buses and their current schedule status."
  • "Create a summary of transit delays on major routes based on NTA data."
  • "Check if my bus (route 7) is on time and when it will arrive at O'Connell Street."
  • "Where are all the DART trains currently located?"
  • "Show me all buses near Dublin city centre right now."
  • "Find the closest buses to Heuston Station at this moment."
  • "Track the current positions of Irish Rail trains."
  • "Are there any service disruptions on the Luas Green Line today?"
  • "Check if there are any alerts affecting bus routes in County Cork."
  • "Give me a list of all current Irish public transport service alerts as bullet points."
  • "Are there any planned maintenance or closures on the DART system this weekend?"

Installation

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-nta.

Using PIP

Alternatively you can install mcp-server-nta via pip:

pip install mcp-server-nta

After installation, you can run it as a script using:

python -m mcp_server_nta

Configuration

Configure for Claude.app

Add to your Claude settings:

Using uvx
{
	"mcpServers": {
		"nta": {
			"command": "uvx",
			"args": ["mcp-server-nta"],
			"env": {
				"NTA_API_KEY": "PROVIDE_API_KEY"
			}
		}
	}
}
Using pip installation
{
	"mcpServers": {
		"nta": {
			"command": "python",
			"args": ["-m", "mcp_server_nta"],
			"env": {
				"NTA_API_KEY": "PROVIDE_API_KEY"
			}
		}
	}
}

Configure for VS Code

For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open User Settings (JSON).

Optionally, you can add it to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

Note that the mcp key is needed when using the mcp.json file.

Using uvx
{
	"mcp": {
		"servers": {
			"nta": {
				"command": "uvx",
				"args": ["mcp-server-nta"],
				"env": {
					"NTA_API_KEY": "PROVIDE_API_KEY"
				}
			}
		}
	}
}

Customization - API Key

An API Key will be required to interface with the NTA API. This API key can be requested by creating an account with the service and requesting one.

Debugging

You can use the MCP inspector to debug the server. For uvx installations:

npx @modelcontextprotocol/inspector uvx mcp-server-nta

Or if you've installed the package in a specific directory or are developing on it:

cd path/to/servers/src/nta
npx @modelcontextprotocol/inspector uv run mcp-server-nta

Testing

The project includes a comprehensive test suite using pytest. You can run the tests with:

Using uv (Recommended)

# Install development dependencies
uv pip install -e ".[dev]"

# Run all tests
uv run pytest

# Run tests with verbose output
uv run pytest -v

Using pip

# Install development dependencies
pip install -e ".[dev]"

# Run all tests
pytest

# Run tests with verbose output
pytest -v

For more details on the test suite, see the test README.

Contributing

We encourage contributions to help expand and improve mcp-server-nta. Whether you want to add new tools, enhance existing functionality, or improve documentation, your input is valuable.

For examples of other MCP servers and implementation patterns, see: https://github.com/modelcontextprotocol/servers

Pull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make mcp-server-nta even more powerful and useful.

License

mcp-server-nta is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ireland_nta_mcp-0.0.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ireland_nta_mcp-0.0.1-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file ireland_nta_mcp-0.0.1.tar.gz.

File metadata

  • Download URL: ireland_nta_mcp-0.0.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ireland_nta_mcp-0.0.1.tar.gz
Algorithm Hash digest
SHA256 a35753e63b7e5d654a9070be83c841a63114574ed58519ccc0562fd7f43cf2c9
MD5 908b9613ec840744a52988b0e9972273
BLAKE2b-256 1d482ad2e11c8b35fa94f868e4d44884c5b508a529c7e664d947c2a99c730d72

See more details on using hashes here.

Provenance

The following attestation bundles were made for ireland_nta_mcp-0.0.1.tar.gz:

Publisher: python.yml on mashour375/ireland-nta-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ireland_nta_mcp-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ireland_nta_mcp-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 af9f55f1ab56d755dbfb2785a8d1f9dfaf673b8388a8aefa1c566f4052423cce
MD5 a4f7e3683aeea9e5d1895b96f9fa9a35
BLAKE2b-256 125c4d00a068e59729e211991d7b003b56f507aa3d2f61de096eef3056a07df8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ireland_nta_mcp-0.0.1-py3-none-any.whl:

Publisher: python.yml on mashour375/ireland-nta-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page