README
🚀 Alterx MCP 桥接工具
Alterx MCP 是连接 Alterx(强大的子域名排列生成工具)与模型上下文协议(MCP)生态系统的桥梁,能将 Alterx 子域名词典生成能力与 MCP 兼容应用及 AI 工作流系统无缝集成,助力自动化子域发现与 AI 助手功能。
🚀 快速开始
Alterx MCP 可将 Alterx 的子域名词典生成能力与 MCP 兼容的应用程序和 AI 工作流系统实现无缝集成。借助此桥接,你能够运用 Alterx 基于模式的排列系统,通过标准化协议将其融入自动化子域发现管道或 AI 助手功能。
✨ 主要特性
- 基于模式的词典生成用于子域发现
- 支持多种排列模式和策略
- 简单配置与设置
- 与其他 MCP 兼容工具和系统的轻松集成
📦 安装指南
先决条件
- Node.js(v16 或更高版本)
- 系统中安装了 Alterx
- MCP SDK
设置步骤
- 克隆此仓库:
git clone https://github.com/cyproxio/mcp-for-security
cd alterx-mcp
- 安装依赖项:
npm install
- 构建项目:
npm run build
💻 使用示例
基础用法
基本配置
在 MCP 客户端配置中配置 Alterx MCP 服务器:
{
"alterx": {
"command": "node",
"args": [
"/path/to/alterx-mcp/build/index.js",
"alterx"
]
}
}
运行 Alterx
配置完成后,可以通过 MCP 接口使用 do-alterx 工具运行 Alterx:
// 使用 MCP 调用 Alterx 的示例
const result = await mcp.tools.invoke("do-alterx", {
domain: "api.example.com",
pattern: "{{word}}-{{sub}}.{{suffix}}",
outputFilePath: "wordlist.txt"
});
高级用法
基本排列
const result = await mcp.tools.invoke("do-alterx", {
domain: "api.example.com",
pattern: "{{sub}}-{{word}}.{{suffix}}"
});
多个模式
const result = await mcp.tools.invoke("do-alterx", {
domain: "api.example.com",
pattern: "{{sub}}-{{word}}.{{suffix}},{{word}}.{{sub}}.{{suffix}}",
outputFilePath: "combined_wordlist.txt"
});
📚 详细文档
参数说明
Alterx MCP 支持以下参数:
domain:用于生成排列的目标域或子域(必需)pattern:用于生成词典变化的模式模板(必需)outputFilePath:保存生成词典的文件路径(可选)
与 AI 助手的集成
Alterx MCP 设计用于与支持模型上下文协议的 AI 助手无缝协作,使子域发现和枚举任务的自然语言交互成为可能。
示例对话
用户:生成 api.example.com 的子域排列
AI:我将使用 Alterx 帮助您生成子域排列。
[AI 使用 Alterx MCP 运行排列并返回结果]
我已经生成了以下子域排列:
- dev-api.example.com
- stage-api.example.com
- test-api.example.com
- api-dev.example.com
- api-stage.example.com
...
安全注意事项
- 请始终在获得适当授权后进行域名子域扫描
- 使用时注意负责任任与道德
- 此工具旨在用于合法的安全研究和测试
故障排除
如遇问题:
- 确保 Alterx 已正确安装且可访问
- 检查配置中 Alterx 可执行文件的路径是否正确
- 确保设置了适当的执行权限
- 查看服务器日志获取详细错误信息
高级用法
在更复杂的场景下,您可以:
- 将 Alterx 与其他子域发现工具链式使用于 MCP 环境中
- 创建自定义词典以适应不同模式,并在扫描中复用
- 构建自动化工作流以生成排列并验证发现的子域
致谢
- Alterx 项目:https://github.com/projectdiscovery/alterx
- 模型上下文协议:https://github.com/modelcontextprotocol
Scan to join WeChat group