使用说明
项目简介
Uncover MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务端应用。它利用 projectdiscovery/uncover 工具,将 Shodan 和 FOFA 这两个强大的网络搜索引擎的能力通过 MCP 协议暴露出来,使得支持 MCP 协议的客户端(例如 AI 助手)能够方便地调用这些搜索引擎进行网络资产 खोज。
主要功能点
- 集成 uncover 工具: 直接使用 projectdiscovery/uncover 库进行 खोज,功能强大且可靠。
- 支持多种搜索引擎: 目前支持 Shodan 和 FOFA,未来可能扩展支持更多搜索引擎。
- 灵活的输出格式: uncover 工具本身支持多种输出格式,MCP Server 默认以文本形式返回 खोज 结果。
- 简易的 MCP 服务接口: 遵循 MCP 协议标准,易于集成到各种 MCP 客户端中。
- 与 AI 助手自然交互: 通过 MCP 协议,可以方便地在 AI 助手中使用自然语言指令调用网络 खोज 功能。
安装步骤
-
克隆仓库
git clone https://github.com/Co5mos/uncover-mcp cd uncover-mcp -
构建项目 确保你已经安装了 Go 语言环境。执行以下命令编译项目:
go build -o uncover-mcp ./cmd/uncover-mcp编译成功后,会在当前目录下生成可执行文件 'uncover-mcp'。
服务器配置
MCP 客户端需要配置 MCP 服务器的启动信息才能连接和使用 Uncover MCP Server。以下是一个示例配置,你需要将其添加到你的 MCP 客户端的服务器配置中。
{ "mcpServers": { "uncover-mcp": { // 服务器名称,可以自定义 "command": "./uncover-mcp", // 启动服务器的命令,这里假设 uncover-mcp 可执行文件在当前目录 "args": [], // 启动参数,本项目无需额外参数 "env": { // 环境变量配置,用于配置 Shodan 和 FOFA 的 API 密钥 "SHODAN_API_KEY": "", // 你的 Shodan API 密钥,请替换成你自己的密钥。如果不需要使用 Shodan,可以留空。 "FOFA_EMAIL": "", // 你的 FOFA 邮箱账号,用于 FOFA 认证,请替换成你自己的账号。如果不需要使用 FOFA,可以留空。 "FOFA_KEY": "" // 你的 FOFA API 密钥,请替换成你自己的密钥。如果不需要使用 FOFA,可以留空。 } } } }
注意:
- 你需要根据你的实际情况配置 'SHODAN_API_KEY', 'FOFA_EMAIL', 和 'FOFA_KEY' 环境变量。这些 API 密钥是使用 Shodan 和 FOFA 搜索引擎所必需的。
- 如果你只需要使用其中一个搜索引擎,可以只配置对应的 API 密钥。
- 确保 'uncover-mcp' 可执行文件在 MCP 客户端能够访问到的路径下,或者在 'command' 中使用正确的绝对路径。
基本使用方法
配置完成后,在支持 MCP 协议的客户端中,你可以使用以下格式的自然语言指令来调用 Uncover MCP Server 的功能。
使用 Shodan 搜索引擎:
Search using Shodan for ssl:"Uber Technologies, Inc."
使用 FOFA 搜索引擎:
Search using FOFA for app="ATLASSIAN-JIRA"
在你的 AI 助手或其他 MCP 客户端中,输入类似的指令,Uncover MCP Server 就会调用相应的搜索引擎进行 खोज,并将结果返回给客户端。 你可以根据 Shodan 和 FOFA 的查询语法构造更复杂的 खोज 语句。
信息
分类
网页与API