MCP Shipxy Api

🚀 shipxy-api-mcp

Shipxy MCP Server 是一個完全符合 MCP 協議的開源海事場景位置服務（LBS）解決方案，為開發者和 AI 智能體提供了一套全面的船舶和港口 API 及工具。它可以讓你的應用程序無縫集成即時船舶數據、航線規劃、天氣、潮汐等信息。

🚀 快速開始

1. 獲取 API 密鑰

在 Shipxy 開放平臺 註冊並創建一個服務器端 API 密鑰。
注意：所有請求都需要使用 API 密鑰。

2. 安裝

pip install -r requirements.txt

3. 配置

在項目根目錄下創建一個 .env 文件：

SHIPXY_API_KEY=your_api_key_here

4. 啟動服務器

建議：使用 mcp.json 配置文件，以便與 MCP CLI 和智能體平臺輕鬆集成。示例如下：

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

✨ 主要特性

• 全面支持 MCP 協議：可與任何符合 MCP 協議的智能體、大語言模型或平臺無縫集成。
• 豐富的海事數據：涵蓋船舶、港口、航線、天氣、潮汐等多方面數據。
• 即時與歷史數據：提供即時船舶跟蹤、航行歷史和事件記錄。
• 開源且可擴展：採用 MIT 許可證，易於定製和擴展。

💻 使用示例

基礎用法

以下是使用 search_ship API 進行船舶模糊搜索的示例：

# 這裡可以添加調用 search_ship API 的示例代碼
# 假設使用 Python 的 requests 庫
import requests

api_key = "your_api_key"
url = f"https://api.shipxy.com/v3/search_ship?api_key={api_key}&keyword=your_search_keyword"
response = requests.get(url)
print(response.json())

高級用法

以下是使用 plan_route_by_point API 進行兩點間航線規劃的示例：

# 高級場景說明：根據給定的兩個座標點，規劃船舶航線
import requests

api_key = "your_api_key"
start_point = "120.0,30.0"
end_point = "121.0,31.0"
url = f"https://api.shipxy.com/v3/plan_route_by_point?api_key={api_key}&start={start_point}&end={end_point}"
response = requests.get(url)
print(response.json())

📚 詳細文檔

支持的 API

🌍 應用場景

• 海事物流與船隊管理
• 船舶跟蹤與監控
• 港口運營與預計到達時間預測
• 智能航運與航線優化
• 海洋天氣與安全應用

🔧 技術細節

項目結構

.
├── server.py           # MCP 服務器入口點
├── ship_service.py     # Shipxy API 集成和業務邏輯
├── requirements.txt    # Python 依賴項
├── pyproject.toml      # 項目元數據
└── README.md           # 本文件

📄 許可證

本項目採用 MIT 許可證，© shipxy-api-mcp 貢獻者

📞 聯繫我們

如需更多信息或商務諮詢，請聯繫： 電話：400 - 010 - 8558 / 010 - 8286 8599