使用说明
海洋MCP服务器
一种模型上下文协议(MCP)服务器,通过海上交通API集成提供海上扇区数据。
概述
该MCP服务器提供用于访问海事数据的工具和资源,包括:
- 船舶位置和跟踪
- 端口信息
- 船舶详细信息和规格
- 海上交通分析
- 路线优化数据
特性
- 船舶跟踪:实时船舶位置和运动数据
- 端口信息:全面的港口详细信息和统计数据
- 船舶数据库:获取船舶规格和详细信息
- 海事分析:交通模式和路线分析
- API集成:无缝海上交通API集成
安装
先决条件
- Python 3.8或更高版本
- 海上交通API关键
设置
- 克隆存储库:
git clone https://github.com/yourusername/marine-mcp-server.git
cd marine-mcp-server
- 安装依赖项:
pip install -e .
- 配置您的海上交通API密钥:
cp .env.example .env
# Edit .env and add your MARINE_TRAFFIC_API_KEY
配置
创建一个 .env 使用您的海上交通API证书在项目根目录中创建文件:
MARINE_TRAFFIC_API_KEY=your_marine_traffic_api_key_here
MARINE_TRAFFIC_BASE_URL=https://services.marinetraffic.com/api
RATE_LIMIT_PER_MINUTE=60
CACHE_EXPIRY_SECONDS=300
用法
运行服务器
marine-mcp-server
可用工具
get_vessel_positions:获取特定区域内船只的当前位置get_vessel_details:获取特定船只的详细信息get_port_info:获取有关端口的信息search_vessels:按各种标准搜索船只get_voyage_info:获取船只的航行信息
可用资源
vessels:船舶基本信息列表ports:包含详细信息的端口目录routes:海上航线信息
发展
设置开发环境
pip install -e ".[dev]"
运行测试
pytest
代码格式化
black src/
isort src/
flake8 src/
类型检查
mypy src/
API文档
该服务器与API海上交通集成。您需要来自的有效API密钥 海上交通.
支持的端点
- 船舶位置
- 船舶详细信息
- 靠港
- 航行信息
- 车队管理
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 如果适用,添加测试
- 运行测试套件
- 提交拉取请求
开发设置
git clone https://github.com/arifemregursoy/marine-mcp-server.git
cd marine-mcp-server
pip install -e ".[dev]"
运行测试
python test_server.py # Complete test suite
python test_simple_mock.py # Mock data tests
python test_api.py # Real API tests (requires key)
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
这意味着:
- ✅ 免费使用 出于任何目的(个人、商业等)
- ✅ 可自由修改 并分发
- ✅ 无担保 -使用风险自负
- ✅ 需要署名 -保留许可证通知
免责声明
本软件按“原样”提供,不提供任何形式的保修。作者不对因使用本软件而产生的任何问题、损害或费用负责。
支持
对于问题和疑问:
- 🐛 在GitHub上打开一个问题
- 📖 检查文档
- 🌐 审查API海上交通文件
致谢
- 海上交通API,用于提供海上数据
- MCP(模型上下文协议)框架
- Python开源社区
更新日志
v0.1.0
- 初始版本
- 基本船舶跟踪功能
- 港口信息工具
- 海上交通API集成