gc-alterx-mcp
v1.1.5
Published
Model Context Protocol (MCP) server for interacting with AlterX HTTP request fuzzer
Downloads
18
Maintainers
Readme
Alterx MCP
Alterx MCP is a bridge that connects Alterx, a powerful subdomain permutation tool, with the Model Context Protocol (MCP) ecosystem.
Overview
Alterx MCP enables seamless integration of Alterx's domain wordlist generation capabilities into MCP-compatible applications and AI-powered workflow systems. This bridge allows you to leverage Alterx's pattern-based permutation system through a standardized protocol, making it easier to incorporate into automated subdomain discovery pipelines or AI assistant capabilities.
Features
- Pattern-based wordlist generation for subdomain discovery
- Support for multiple permutation patterns and strategies
- Simple configuration and setup
- Easy integration with other MCP-compatible tools and systems
Installation
Prerequisites
- Node.js (v16 or higher)
- Alterx installed on your system
Installation
# Install globally
npm install -g gc-alterx-mcp
# Or run directly without installing
npx gc-alterx-mcpConfiguration
This server requires the path to the Alterx executable to be set via the ALTERX_PATH environment variable.
Example:
# Linux/macOS
export ALTERX_PATH=/usr/local/bin/alterx
# Windows
set ALTERX_PATH=C:\path\to\alterx\alterx.exeUsage
Command Line
# With ALTERX_PATH environment variable set
npx gc-alterx-mcpWith Claude Desktop
Add to your claude_desktop_config.json:
{
"mcpServers": {
"alterx": {
"command": "npx",
"args": ["-y", "gc-alterx-mcp"],
"env": {
"ALTERX_PATH": "C:\\path\\to\\alterx\\alterx.exe"
}
}
}
}With Other MCP Clients
For other MCP clients, you can configure them to use this server with:
ALTERX_PATH=/path/to/alterx npx gc-alterx-mcpRunning Alterx
Once configured, you can run Alterx through the MCP interface using the do-alterx tool:
// Example of calling Alterx through MCP
const result = await mcp.tools.invoke("do-alterx", {
domain: "api.example.com",
pattern: "{{word}}-{{sub}}.{{suffix}}",
outputFilePath: "wordlist.txt"
});Parameters
Alterx MCP supports the following parameters:
domain: The target domain or subdomains to use as a base for creating permutations (required)pattern: The pattern template to use for generating wordlist variations (required)outputFilePath: Path where the generated wordlist should be saved (optional)
Examples
Basic Permutation
const result = await mcp.tools.invoke("do-alterx", {
domain: "api.example.com",
pattern: "{{sub}}-{{word}}.{{suffix}}"
});Multiple Patterns
const result = await mcp.tools.invoke("do-alterx", {
domain: "api.example.com",
pattern: "{{sub}}-{{word}}.{{suffix}},{{word}}.{{sub}}.{{suffix}}",
outputFilePath: "combined_wordlist.txt"
});Integration with AI Assistants
Alterx MCP is designed to work seamlessly with AI assistants that support the Model Context Protocol, enabling natural language interactions for subdomain discovery and enumeration tasks.
Example conversation with an AI assistant:
User: Generate subdomain permutations for api.example.com
AI: I'll help you generate subdomain permutations using Alterx.
[AI uses Alterx MCP to run the permutation and returns the results]
I've generated the following subdomain permutations:
- dev-api.example.com
- stage-api.example.com
- test-api.example.com
- api-dev.example.com
- api-stage.example.com
...Security Considerations
- Always obtain proper authorization before scanning domains for subdomains
- Use responsibly and ethically
- This tool is intended for legitimate security research and testing
Troubleshooting
If you encounter issues:
- Verify Alterx is properly installed and accessible
- Check the path to the Alterx executable in your configuration
- Ensure proper permissions are set for execution
- Review server logs for detailed error messages
License
Apache-2.0
Acknowledgments
- Alterx Project: https://github.com/projectdiscovery/alterx
- Model Context Protocol: https://github.com/modelcontextprotocol
