Shipxy

Provides MCP-compliant maritime APIs for ships, ports, routes, weather, and tides to empower LBS and AI-driven maritime applications.

python

9

GitHub Stars

python

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": {
    "garrettxu-mcp-shipxy-api": {
      "command": "python",
      "args": [
        "/path/to/your/server.py"
      ],
      "env": {
        "SHIPXY_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

Shipxy MCP Server is a fully MCP-compliant maritime data platform that exposes ship tracking, port details, weather, tides, and route planning through MCP-enabled APIs. Use it to enrich your apps, agents, or LLMs with real-time and historical maritime information for planning, monitoring, and safety.

How to use

Connect to Shipxy MCP Server from any MCP-compatible client or agent. You will typically register or supply an API key, then issue API calls to search ships, query ports, get weather, plan routes, or retrieve vessel tracks. Use the provided start command to run the local server, and configure your MCP client to point at the server’s MCP endpoint or process.

How to install

Prerequisites: Python installed on your system and pip to install dependencies.

Install dependencies.

pip install -r requirements.txt

Create a configuration file or set environment variables. You will need your Shipxy API key.
Run the MCP server using the recommended stdio configuration. The example shows running the Python server script with your API key in the environment.

{
  "mcpServers": {
    "shipxy_api_mcp": {
      "command": "python",
      "args": ["/path/to/your/server.py"],
      "env": {
        "SHIPXY_API_KEY": "your_api_key_here"
      }
    }
  }
}

Start the server with the configuration loaded by your MCP client or CLI tool. Ensure the API key is set in the environment so all requests are authenticated.

Additional notes

If you already have a running process, you can adapt the command to your environment. The important parts are: set SHIPXY_API_KEY in the environment and point to the Python script that runs the Shipxy MCP server.

Configuration

Environmental configuration is required so the server can authenticate with Shipxy and access its data sources. The key you provide will be used by all MCP calls.

Security

Keep your API key secure. Do not commit it to source control and use environment variables or secret management to inject it at runtime.

Troubleshooting

If calls time out or return errors, verify that the API key is valid, the server process is running, and the MCP client is configured to reach the correct endpoint.

Available tools

search_ship

Fuzzy search for ships by MMSI, IMO, name, or call sign

get_single_ship

Query real-time info for a single ship by MMSI

get_many_ship

Query real-time info for multiple ships by MMSI list

get_fleet_ship

Query all ships in a fleet

get_surrounding_ship

Query ships within 10nm of a given ship

get_area_ship

Query ships in a specified area

get_ship_registry

Query ship registry/country info

search_ship_particular

Query ship particulars by MMSI/IMO/call sign/name

search_port

Fuzzy search for ports by name or code

get_berth_ships

Query ships currently berthed at a port

get_anchor_ships

Query ships at anchor at a port

get_eta_ships

Query ships with ETA to a port

get_ship_track

Query historical track points for a ship

search_ship_approach

Query ship-to-ship approach events

get_port_of_call_by_ship

Query port call records for a ship

get_port_of_call_by_port

Query port call records for a port

plan_route_by_point

Plan route between two coordinates

plan_route_by_port

Plan route between two ports

get_single_eta_precise

Get ETA and voyage info for a ship

get_weather_by_point

Query marine weather by coordinates

get_weather

Query marine weather by area

get_all_typhoon

List recent typhoons

get_single_typhoon

Query details for a specific typhoon

get_tides

List tide stations

get_tide_data

Query tide data for a station