# Hunter MCP Server

A Model Context Protocol (MCP) server that provides access to Hunter (Qianxin) API functionality, allowing AI assistants to query information about internet-connected devices and services.

## Installation
1. Clone the repository:
   ```bash
   git clone https://github.com/help116114/hunter-mcp-server.git
   cd hunter-mcp-server
   ```
2. Install dependencies:
   ```bash
   npm install
   ```
3. Build the server:
   ```bash
   npm run build
   ```
4. Set up your Hunter API key and email:
   ```bash
   export Hunter_API_KEY="your-api-key-here"
   ```
5. Start the server:
   ```bash
   npm start
   ```
## Setup
To integrate this server with Claude or other MCP-compatible AI assistants, follow these steps:
1. Add the server to your MCP settings:
```json
{
  "mcpServers": {
    "hunter": {
      "command": "node",
      "args": ["/path/to/hunter-mcp-server/build/index.js"],
      "env": {
        "HUNTER_API_KEY": "your-api-key-here"
      }
    }
  }
}
```
2. Restart Claude to load the new MCP server.

## Features
- **Search Functionality**: Query Hunter's database using various search criteria such as IP, domain, header, web info, ICP 备案信息，protocol/port, app components, cert, vul, AS, and tls - jarm.
- **Result Sampling**: Limit the response data to reduce token usage, which is useful when dealing with large datasets.
Resource Management**: Provide access to search results as resources with proper URIs.
- **CSV Export**: Export search results to a CSV file for further analysis.

  
## Tools
### `search_hunter`
- **Description**: Search Hunter's database for devices and services.
- **Parameters**:
	- `query (required)`: Hunter search query (e.g., 'ip="1.1.1.1"').
	- `page (optional)`: Page number for results pagination (default: 1).
	- `size (optional)`: Number of results per page (default: 10).
	- `fields (optional)`: List of fields to include in the results (e.g., ['ip', 'port', 'title']).
	
### `export_to_csv`
- **Description**: Export Hunter search results to a CSV file.
- **Parameters**:
	- `query (required)`: Hunter search query (e.g., 'ip="1.1.1.1"').
	- `outputPath (required)`: Path to the output CSV file.
	- `page (optional)`: Page number for results pagination (default: 1).
	- `size (optional)`: Number of results per page (default: 10).
	- `fields (optional)`: List of fields to include in the results (e.g., ['ip', 'port', 'title']).

## Requirements
- Node.js: The server is built using Node.js. Make sure - you have Node.js (version 14.17 or higher) installed on your system.
- Hunter API Key: You need a valid Hunter API key to access the Hunter API. You can obtain the API key from the [Hunter platform](https://hunter.qianxin.com/home/helpCenter).