MCP Shipxy Api

🚀 shipxy-api-mcp

Shipxy MCP Server is an open - source Location - Based Service (LBS) solution fully compliant with the MCP protocol, designed for maritime scenarios. It offers a comprehensive set of ship and port APIs and tools for developers and AI agents, enabling seamless integration of real - time vessel data, route planning, weather, tides, and more into your applications.

🚀 Quick Start

1. Get Your API Key

Register and create a server - side API Key at Shipxy Open Platform.
⚠️ Important Note The API key is required for all requests.

2. Installation

pip install -r requirements.txt

3. Configuration

Create a .env file in your project root:

SHIPXY_API_KEY=your_api_key_here

4. Start the Server

It is recommended to use an mcp.json configuration file for easy integration with MCP CLI and agent platforms. Example:

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

✨ Features

• Full MCP Protocol Support: Seamlessly integrate with any MCP - compliant agent, LLM, or platform.
• Comprehensive Maritime Data: Covers ships, ports, routes, weather, tides, and more.
• Real - Time & Historical Data: Enables live vessel tracking, voyage history, and event records.
• Open Source & Extensible: Licensed under MIT, easy to customize and extend.

💻 Usage Examples

Basic Usage

The following shows how to use the search_ship API to perform a fuzzy search for ships:

# Assume you have a function to call the API
import requests
import os

api_key = os.getenv('SHIPXY_API_KEY')
url = f'https://your_api_url/search_ship?keyword=your_search_keyword&api_key={api_key}'
response = requests.get(url)
print(response.json())

Advanced Usage

Here is an example of using the plan_route_by_port API to plan a route between two ports:

import requests
import os

api_key = os.getenv('SHIPXY_API_KEY')
url = f'https://your_api_url/plan_route_by_port?port1=port1_code&port2=port2_code&api_key={api_key}'
response = requests.get(url)
print(response.json())

📚 Documentation

Supported APIs

Application Scenarios

• Maritime Logistics & Fleet Management
• Vessel Tracking & Monitoring
• Port Operations & ETA Prediction
• Smart Shipping & Route Optimization
• Marine Weather & Safety Applications

Project Structure

.
├── server.py           # MCP server entry point
├── ship_service.py     # Shipxy API integration and business logic
├── requirements.txt    # Python dependencies
├── pyproject.toml      # Project metadata
└── README.md           # This file

📄 License

MIT © shipxy-api-mcp contributors

📞 Contact

For more information or business inquiries, please contact:

Phone: 400 - 010 - 8558 / 010 - 8286 8599