🚀 sec - mcp 使用说明

sec - mcp 是由 Montimage 公司开发的一款用于网络安全监控和威胁检测的工具。它具备多种实用功能，如管理黑名单数据库、批量检查网址或 IP 地址的安全性，还能通过 API 或 MCP 服务器集成到 AI 驱动的客户端中。

🚀 快速开始

安装步骤

创建虚拟环境

1. 创建虚拟环境：

python3.12 -m venv .venv

2. 激活虚拟环境：

source .venv/bin/activate  # 对于 macOS/Linux
或者
.venv\Scripts\activate  # 对于 Windows

3. 安装 sec - mcp：

pip install sec - mcp

使用说明

作为工具使用

1. 验证状态：

sec - mcp status

2. 更新黑名单数据库：

sec - mcp update

3. 批量检查文件中的内容：

sec - mcp batch urls.txt

通过 API 使用

# 导入模块并初始化
from sec_mcp import SecMCP

client = SecMCP()

# 更新数据库
client.update()

# 单个检查
result = client.check("https://example.com")
print(result.to_json())

# 批量检查
urls = ["https://example.com", "https://test.com"]
results = client.check_batch(urls)
for r in results:
    print(r.to_json())

作为 MCP 服务器使用

1. 配置 MCP 客户端： 将以下内容添加到客户端的配置文件中：

{
    "mcpServers": {
        "sec - mcp": {
            "command": "/absolute/path/to/.venv/bin/python",
            "args": ["-m", "sec_mcp.start_server"]
        }
    }
}

2. 注意事项：

⚠️ 重要提示

• 使用虚拟环境中 Python 可执行文件的绝对路径。
• 对于 Windows 系统，路径可能类似于：C:\path\to\.venv\Scripts\python.exe

✨ 主要特性

新增功能

RPC 端点

• check_batch(values: List[str])：批量检查多个域名、URL 或 IP 地址。返回一个包含 { value, is_safe, explanation } 的列表。
• sample_blacklist(count: int)：返回黑名单条目中的随机样本，数量由指定参数决定。
• get_source_stats()：获取详细统计信息，包括总条数、每个数据源的计数和最后更新时间戳。
• get_update_history(source?: str, start?: str, end?: str)：获取更新历史记录，可按来源或时间段过滤。
• flush_cache()：清除内存中的 URL/IP 缓存。返回 { cleared: bool }。
• health_check()：执行数据库和调度器的健康检查。返回 { db_ok: bool, scheduler_alive: bool, last_update: timestamp }。
• add_entry(url: str, ip?: str, date?: str, score?: float, source?: str)：手动添加黑名单条目。返回 { success: bool }。
• remove_entry(value: str)：根据 URL 或 IP 地址移除特定的黑名单条目。返回 { success: bool }。

配置选项

可以通过 config.json 文件进行配置：

示例配置

{
    "blacklist_sources": [
        "https://example.com/blacklist.txt",
        "http://another - source.net/list"
    ],
    "batch_size": 100,
    "api_timeout": 30
}

📄 许可证

sec - mcp 是开源软件，遵循 MIT 许可证。查看完整的许可信息请访问：https://github.com/montimage/sec - mcp/blob/main/LICENSE

📚 详细文档

公司信息

Montimage 公司

• 地址：Paris, France
• 官网：https://www.montimage.com
• 支持邮箱：support@montimage.com

更新日志

版本 1.0.0 (2023 - 10 - 15)

• 首次发布 sec - mcp 工具
• 添加基本功能模块
• 初始版本的文档完成