ORKL MCP Server

这是一个用于访问ORKL 威胁情报库的MCP（模型控制协议）服务器。

目录

• 特性
• 快速开始
  • 前置条件
  • 安装
  • 配置
• MCP 工具
• MCP 资源
• 示例提示
• 许可证

特性

• 通过ORKL API访问ORKL威胁情报库数据
• 高效缓存以减少API调用次数
• 速率限制以遵守ORKL API限制
• 标准化的MCP工具和资源用于LLM交互
• 内置支持Claude Desktop集成

截图

<img src="docs/img/claude_desktop_screenshot.png" width="500" >

快速开始

前置条件

• Python 3.10或更高版本
• uv包管理器（推荐）

安装

1. 克隆仓库：

   git clone https://github.com/heiths/orkl_mcp_server.git
   cd orkl_mcp_server
   

2. 使用uv安装依赖（推荐）：

   uv venv
   uv pip install -r requirements.txt
   

3. 配置服务器（参见下面的配置部分）

注册到Claude Desktop

在你的claude_desktop_config.json中添加以下配置：

{
  "ORKL 威胁情报": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/orkl_mcp_server",  <-- 替换为你克隆的仓库路径
      "run",
      "python",
      "run_server.py"
    ],
    "env": {
      "ORKL_API_BASE_URL": "https://orkl.eu/api/v1",
      "ORKL_REQUEST_TIMEOUT": "30",
      "ORKL_CACHE_TTL": "300",
      "ORKL_USE_CACHE": "1",
      "ORKL_RATE_LIMIT_REQUESTS": "90",
      "ORKL_RATE_LIMIT_PERIOD": "30"
    }
  }
}

MCP 工具

该服务器提供以下MCP工具：

• fetch_latest_threat_reports: 获取最近的威胁情报报告
• fetch_threat_report_details: 获取特定报告的详细信息
• fetch_threat_report_by_hash: 通过SHA1哈希检索报告
• search_threat_reports: 搜索符合标准的报告
• get_library_info: 获取关于ORKL库的信息
• get_library_version: 获取版本信息
• fetch_threat_actors: 获取所有威胁行为者的列表
• fetch_threat_actor_details: 获取威胁行为者详细信息
• fetch_sources: 获取可用来源列表
• fetch_source_details: 获取来源详细信息
• clear_cache: 清除本地缓存以获取新鲜数据

MCP 资源

该服务器提供以下MCP资源：

• threat_reports://{report_id}: 直接访问特定报告
• threat_actors://{actor_id}: 直接访问威胁行为者信息
• sources://{source_id}: 直接访问来源信息

示例提示

恶意软件调查

我发现了一个可疑文件，其SHA1哈希值为'5f2b7f47b2c9da342583c3a7e3887b4babad0fa9'。你能检查这个哈希是否与ORKL数据库中的任何已知威胁相关，并提供有关其功能和归属的详细信息吗？

威胁态势概览

你能提供当前针对金融机构的威胁态势概览吗？使用ORKL API搜索过去一个月的相关威胁报告，并识别新兴趋势或值得注意的威胁行为者。

配置

可以通过以下方式提供配置：

1. 环境变量
2. 当前目录下的JSON配置文件（config.json）

环境变量

变量名称	描述	默认值
ORKL_API_BASE_URL	API基础URL	https://orkl.eu/api/v1
ORKL_REQUEST_TIMEOUT	请求超时时间（秒）	30
ORKL_CACHE_TTL	缓存生存时间（秒）	300
ORKL_USE_CACHE	启用缓存（1/0）	1
ORKL_RATE_LIMIT_REQUESTS	每周期最大请求次数	90
ORKL_RATE_LIMIT_PERIOD	速率限制周期（秒）	30
ORKL_CONFIG_FILE	配置文件路径	config.json

许可证

本项目采用MIT许可证——详情请参阅LICENSE文件。