使用说明

项目简介

Maigret MCP服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，它将强大的开源情报（OSINT）工具 Maigret 封装成 MCP 服务器，旨在为大型语言模型（LLM）客户端提供用户名搜索和URL分析能力。通过此服务器，LLM可以调用 Maigret 的功能，在数百个社交网络和网站上查找用户名信息，并分析URL以提取相关数据，从而扩展 LLM 在信息搜集和分析方面的能力。

主要功能点

用户名搜索: 允许LLM客户端通过 'search_username' 工具，在数百个社交网络和网站上搜索特定用户名是否存在，并生成包含详细信息的报告。
URL分析: 允许LLM客户端通过 'parse_url' 工具，分析URL链接，提取网站信息并尝试查找与URL相关的用户名。
多种报告格式: 支持生成 txt, html, pdf, json, csv, xmind 等多种格式的报告，方便不同场景下的数据处理和展示。
站点过滤: 支持根据标签（例如 photo, dating, us）过滤搜索站点，缩小搜索范围，提高效率。
Docker 部署: 服务器基于 Docker 镜像运行，保证了环境一致性和部署的便捷性。

安装步骤

安装 Docker: Maigret MCP 服务器依赖 Docker 运行 Maigret 工具。请根据您的操作系统安装 Docker Desktop。
- macOS: Docker Desktop for Mac
- Linux: Docker Engine 安装指南
- Windows: Docker Desktop for Windows

安装 Maigret MCP 服务器: 使用 npm 全局安装 'mcp-maigret' 包。

npm install -g mcp-maigret

创建报告目录: 创建一个目录用于存放 Maigret 生成的报告文件。例如，在 '/path/to/reports/directory' 创建目录。
```
mkdir -p /path/to/reports/directory
```
注意: 请确保此目录您有写入权限。

配置 MCP 客户端 (例如 Claude Desktop): 打开您的 MCP 客户端的配置文件（以 Claude Desktop 为例，配置文件路径见下方）。在 'mcpServers' 部分添加 'maigret' 服务器的配置。

Claude Desktop 配置文件路径:

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%\Claude\claude_desktop_config.json'

添加以下 JSON 配置到 'mcpServers' 中:

{
  "mcpServers": {
    "maigret": {  // 服务器名称，可以自定义
      "command": "mcp-maigret", // 启动服务器的命令
      "env": {
        "MAIGRET_REPORTS_DIR": "/path/to/reports/directory"  // 报告文件存放目录的绝对路径，请替换为实际路径
      }
    }
  }
}

请务必将 '/path/to/reports/directory' 替换为您在步骤3中创建的报告目录的绝对路径。

重启 MCP 客户端: 保存配置文件后，重启您的 MCP 客户端 (如 Claude Desktop) 使配置生效。

服务器配置

上述安装步骤中的 JSON 配置是 MCP 客户端连接 Maigret MCP 服务器的关键。配置项说明如下：

{
  "mcpServers": {
    "maigret": {  // 服务器名称，客户端用此名称来标识和调用
      "command": "mcp-maigret", // 启动 Maigret MCP 服务器的命令，全局安装后可以直接使用 "mcp-maigret"
      "env": {
        "MAIGRET_REPORTS_DIR": "/path/to/reports/directory"  // 环境变量，指定 Maigret 报告文件存放的目录，**必须配置为步骤3中创建的目录的绝对路径**
      }
      // "args": [] // (可选) 如果启动命令需要额外的参数，可以在这里配置，本例中不需要
    }
  }
}

基本使用方法

配置完成后，在您的 MCP 客户端中，您应该能够看到名为 'maigret' 的 MCP 服务器。您可以指示 LLM 客户端使用 'maigret' 服务器提供的工具来执行用户名搜索或URL分析。

工具列表:

'search_username' (用户名搜索工具)

描述: 在社交网络和网站上搜索用户名。
参数:
- 'username' (必填): 要搜索的用户名 (字符串)。
- 'format' (可选): 报告输出格式，默认为 "pdf"，可选值包括 "txt", "html", "pdf", "json", "csv", "xmind" (字符串)。
- 'use_all_sites' (可选): 是否搜索所有站点（而不仅仅是排名前500的站点），默认为 'false' (布尔值)。
- 'tags' (可选): 用于过滤站点的标签数组，例如 '["photo", "dating"]' (字符串数组)。

使用示例 (JSON 格式的工具参数):

{
  "tool_call": {
    "server_name": "maigret",
    "tool_name": "search_username",
    "parameters": {
      "username": "test_user",
      "format": "html",
      "tags": ["photo", "social"]
    }
  }
}

'parse_url' (URL分析工具)

描述: 解析URL以提取信息并搜索关联的用户名。
参数:
- 'url' (必填): 要分析的URL (字符串)。
- 'format' (可选): 报告输出格式，默认为 "pdf"，可选值与 'search_username' 相同 (字符串)。