Security Tools Bridge

🚀 Alterx MCP Bridging Tool

Alterx MCP is a bridge that connects Alterx, a powerful subdomain permutation generator, with the Model Context Protocol (MCP) ecosystem.

🚀 Quick Start

Alterx MCP enables the seamless integration of Alterx's subdomain dictionary generation capabilities with MCP-compatible applications and AI workflow systems. Through this bridge, you can leverage Alterx's pattern-based permutation system and integrate it into automated subdomain discovery pipelines or AI assistant functions via a standardized protocol.

✨ Features

• Pattern-based dictionary 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 in the system
• MCP SDK

Setup Steps

1. Clone this repository:

   git clone https://github.com/cyproxio/mcp-for-security
   cd alterx-mcp
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

💻 Usage Examples

Basic Configuration

Configure the Alterx MCP server in the MCP client configuration:

{
  "alterx": {
    "command": "node",
    "args": [
      "/path/to/alterx-mcp/build/index.js",
      "alterx"
    ]
  }
}

Run Alterx

After configuration, you can run Alterx using the do-alterx tool through the MCP interface:

// Example of calling Alterx using MCP
const result = await mcp.tools.invoke("do-alterx", {
  domain: "api.example.com",
  pattern: "{{word}}-{{sub}}.{{suffix}}",
  outputFilePath: "wordlist.txt"
});

Parameter Explanation

Alterx MCP supports the following parameters:

• domain: The target domain or subdomain for generating permutations (required)
• pattern: The pattern template for generating dictionary variations (required)
• outputFilePath: The file path to save the generated dictionary (optional)

Basic Usage

const result = await mcp.tools.invoke("do-alterx", {
  domain: "api.example.com",
  pattern: "{{sub}}-{{word}}.{{suffix}}"
});

Advanced Usage

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 seamlessly collaborate with AI assistants that support the Model Context Protocol, enabling natural language interaction for subdomain discovery and enumeration tasks.

User: Generate subdomain permutations for api.example.com
AI: I will use Alterx to help you generate subdomain permutations.

[AI runs permutations using Alterx MCP and returns results]

I have 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
...

📚 Documentation

Important Notes

• Always conduct domain subdomain scans after obtaining appropriate authorization.
• Use the tool responsibly and ethically.
• This tool is intended for legal security research and testing.

Troubleshooting

If you encounter issues:

1. Ensure that Alterx is correctly installed and accessible.
2. Check if the path to the Alterx executable in the configuration is correct.
3. Ensure that appropriate execution permissions are set.
4. Check the server logs for detailed error information.

Advanced Usage

In more complex scenarios, you can:

1. Chain Alterx with other subdomain discovery tools in the MCP environment.
2. Create custom dictionaries to suit different patterns and reuse them in scans.
3. Build automated workflows to generate permutations and validate discovered subdomains.

📄 License

Acknowledgments

• Alterx Project: https://github.com/projectdiscovery/alterx
• Model Context Protocol: https://github.com/modelcontextprotocol