MCP Maigret

🚀 Maigret MCP Server

A Model Context Protocol (MCP) server for Maigret, a powerful Open-Source Intelligence (OSINT) tool that can collect user account information from multiple public sources. This server provides tools for searching usernames on social networks and websites and analyzing URLs, and is designed to seamlessly integrate with MCP-compatible applications such as Claude Desktop.

🚀 Quick Start

Installation via Smithery

1. Open your terminal and run the following command:

   npm install -g maigret
   

2. Start the service:

   maigret serve
   

Manual Installation

1. Clone the repository:

   git clone https://github.com/yourusername/maigret.git
   cd maigret
   

2. Install dependencies and build:

   npm install
   npm run build
   

3. Configure the environment variable MAIGRET_REPORTS_DIR, for example:

   export MAIGRET_REPORTS_DIR="/path/to/reports"
   

4. Start the service:

   npm start
   

Optional: Installation from Source Code

1. Clone the repository:

   git clone https://github.com/yourusername/maigret.git
   cd maigret
   

2. Install dependencies and build:

   npm install
   npm run build
   

3. Configure the MAIGRET_REPORTS_DIR environment variable, for example:

   export MAIGRET_REPORTS_DIR="/path/to/reports"
   

4. Start the service:

   npm start
   

✨ Features

Tools

1. search_username
   • Description: Search for a username on multiple social networks and websites.
   • Parameters:

     {
       "username": "target_user",
       "format": "pdf" // Optional: txt, html, json, csv
     }
     

2. parse_url
   • Description: Analyze the content of a specified URL and extract intelligence.
   • Parameters:

     {
       "url": "https://example.com/profile",
       "format": "txt" // Optional: pdf, html, json, csv
     }
     

🔧 Technical Details

Installation Requirements

• Node.js and npm: Node.js 8 or higher and npm are required.
• Docker: Docker 1.20 or higher is required.
• Operating System Compatibility: Linux, macOS, and Windows (with Docker Desktop installed) are supported.

Troubleshooting

Docker Issues

1. Verify that Docker is installed and running:

   docker --version
   docker ps
   

2. Check Docker permissions:
   • Ensure that the current user has permission to run Docker commands.
   • On Linux, add the user to the docker group: sudo usermod -aG docker $USER

Report Directory Issues

1. Verify the report directory:

   • Ensure that the directory specified by MAIGRET_REPORTS_DIR exists.
   • Ensure that the current user has write permissions.
   • Check permissions: ls -la /path/to/reports/directory

2. Common configuration errors:

   • The MAIGRET_REPORTS_DIR environment variable is not set.
   • The directory does not exist.
   • Permission issues.
   • A trailing slash at the end of the path.

3. After resolving the issues:

   • Save the configuration file.
   • Restart Claude Desktop.

Error Messages

• "Docker is not installed or not running": Please install Docker and start the Docker daemon.
• "MAIGRET_REPORTS_DIR environment variable is not set": Add the environment variable to the configuration.
• "Error creating the report directory": Check the directory permissions and path.
• "Error executing Maigret": Check the Docker logs and ensure that the container has the correct permissions.

🤝 Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

⚠️ Important Note

Please use this tool legally and responsibly. Only use it for compliant purposes and respect privacy and data protection laws.