> ## Documentation Index
> Fetch the complete documentation index at: https://pentest-tools.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# MCP tools
Full reference for the Pentest-Tools.com MCP server. Scanning, target management, reporting, everything your AI assistant can touch, documented.
## Scanning Tools
### **run\_website\_scanner**
Run a website vulnerability scanner on a target URL.
| **Parameter** | **Type** | **Required** | **Description** |
| :------------------------------ | :------- | :----------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| **target** | string | Yes | Target URL (e.g., [https://example.com](https://example.com)) |
| **scan\_type** | string | No | light (default), deep, or custom |
| **attack\_active** | array | No | Active attacks: xss, sqli, lfi, ssrf, ssti, xxe, etc. |
| **attack\_passive** | array | No | Passive checks: security\_headers, cookie\_security, etc. |
| **discovery** | array | No | Discovery modules: fingerprint, sensitive\_files, etc. |
| **spider** | object | No | Crawl options: `approach` (`auto`\|`classic`\|`spa`), `depth` (default 10), `include_urls`, `exclude_urls`, `subdomains_in_scope` |
| **auth\_headers** | array | No | HTTP headers for authentication (e.g., `["Authorization: Bearer token123"]`) |
| **auth\_cookies** | string | No | Cookie string for session-based authentication (e.g., `"PHPSESSID=abc123; token=xyz"`) |
| **auth\_login\_form\_url** | string | No | URL of the login page for form-based authentication |
| **auth\_login\_form\_username** | string | No | Username for form-based authentication |
| **auth\_login\_form\_password** | string | No | Password for form-based authentication |
| **requests\_per\_second** | integer | No | Max requests per second (1–10000, default 100) |
| **max\_scan\_time** | integer | No | Max scan duration in minutes (5–1440, default 5) |
| **workspace\_id** | integer | No | Workspace for the scan |
| **vpn\_profile\_uuid** | string | No | VPN profile for internal scanning |
**Authenticated scanning** configuration is complex. LLMs may require a few attempts to construct the parameters correctly. Provide explicit examples in your prompts.
For all the parameter options of **attack\_active, attack\_passive** and **discovery,** see the [API reference](/api-reference/index) > scans > Start a scan > Website Scanner.
### **run\_subdomain\_finder**
Discover subdomains for a target domain.
| **Parameter** | **Type** | **Required** | **Description** |
| :------------------ | :------- | :----------- | :------------------------------------------------------ |
| **target** | string | Yes | Target domain (e.g., [example.com](http://example.com)) |
| **scan\_type** | string | No | light (default), deep, or custom |
| **web\_details** | boolean | No | Include web server details |
| **whois** | boolean | No | Include WHOIS information |
| **search\_methods** | object | No | Custom methods: dns\_enumeration, ctr\_search, etc. |
### **run\_network\_scanner**
Run a network vulnerability scanner or port scanner.
| **Parameter** | **Type** | **Required** | **Description** |
| :-------------------- | :------- | :----------- | :----------------------------------------------- |
| **target** | string | Yes | Hostname or IP address |
| **preset** | string | No | light (default), deep, or custom |
| **scanning\_engines** | array | No | Engines: version\_based, sniper, nuclei, openvas |
| **protocol\_type** | string | No | tcp (default) or udp |
| **port\_range** | object | No | start\_port, end\_port |
| **port\_list** | array | No | Specific ports: \[22, 80, 443] |
| **just\_scan\_ports** | boolean | No | Port scan only (no vulnerability checks |
## Management Tools[****](https://pentest-toolscom-34533c73.mintlify.app/ai/mcp/tools-reference#get-scans)
### **get\_scans**
Retrieve scans with optional filtering.
| **Parameter** | **Type** | **Description** |
| :---------------- | :------- | :--------------------------------------- |
| **workspace\_id** | integer | Filter by workspace |
| **target\_id** | integer | Filter by target |
| **status** | string | Filter: running, finished, stopped, etc. |
| **limit** | integer | Max results |
| **page** | integer | Page number |
### **scan**
Manage individual scans using various verbs.
| **Verb** | **Parameters** | **Description** |
| :---------------------- | :--------------------------------- | :------------------------------------ |
| **get\_status** | scan\_id | Get scan status and progress |
| **get\_output** | scan\_id | Get parsed JSON output |
| **get\_raw\_output** | scan\_id | Get raw output |
| **stop** | scan\_id | Stop a running scan |
| **delete** | scan\_id | Delete a scan (requires confirmation) |
| **start\_by\_targetid** | target\_id, tool\_id, tool\_params | Start scan on existing target |
## Targets
### **get\_targets / target**
| **Tool** | **Verb** | **Parameters** | **Description** |
| :----------- | :------- | :--------------------------------- | :-------------- |
| get\_targets | — | workspace\_id, target\_type, limit | List targets |
| target | add | name, description, workspace\_id | Create target |
| target | delete | target\_id | Delete target |
### **workspace**
| **Verb** | **Parameters** | **Description** |
| :------- | :------------------------------- | :-------------------- |
| list | — | Get all workspaces |
| get | workspace\_id | Get workspace details |
| create | name, description | Create workspace |
| edit | workspace\_id, name, description | Update workspace |
| delete | workspace\_id | Delete workspace |
### **findings**
| **Verb** | **Parameters** | **Description** |
| :-------------------------------- | :------------- | :------------------ |
| get | — | Get all findings |
| get\_finding\_information\_by\_id | finding\_id | Get finding details |
### **import\_findings**
Import external findings into [Pentest-Tools.com](http://Pentest-Tools.com).
| **Parameter** | **Type** | **Required** | **Description** |
| :------------ | :------- | :----------- | :----------------------- |
| findings | array | Yes | Array of finding objects |
Each finding requires: target\_name, source, name, vuln\_description, vuln\_risk\_level, vuln\_recommendation, cvss\_v3, vuln\_evidence
## Reports
### **create\_report**
Generate a new report.
| **Parameter** | **Type** | **Required** | **Description** |
| :------------ | :------- | :----------- | :------------------------------- |
| format | string | Yes | pdf, html, json, csv, xlsx, docx |
| group\_by | string | Yes | target or vulnerability |
| source | string | Yes | scans or findings |
| resources | array | Yes | Scan IDs or finding IDs |
| webhook\_url | string | No | Notification URL |
### **report**
Handle and download reports
| **Verb** | **Parameters** | **Description** |
| :------------------------------- | :------------- | :-------------------- |
| get\_all | — | List all reports |
| get\_report\_information\_by\_id | report\_id | Get report details |
| download | report\_id | Download report file. |
| delete | report\_id | Delete report |
Best practices for Handling Large Reports: When requesting a PDF report download via the MCP, keep in mind that the API returns large raw binary data, which might use a lot of context. We recommend instructing the AI to "Save the PDF report to a local file" rather than "Show me the report," as the latter may result in a large block of unreadable text in your terminal or limit interactions with the Generate PDF functionality.
### **translate\_report**
LLM-powered tool that uses AI to translate vulnerability findings. Creates a new report from the generated translated findings.
| **Parameter** | **Type** | **Required** | **Description** |
| :--------------- | :------- | :----------- | :-------------------------------- |
| report\_id | integer | Yes | Report to translate |
| target\_language | string | Yes | e.g., Spanish, French, German |
| workspace\_id | integer | Yes | Workspace for translated findings |
## Utilities
### **http\_logger**
Manage HTTP request loggers for out-of-band testing.
| **Verb** | **Parameters** | **Description** |
| :------- | :------------------- | :---------------- |
| create | label, workspace\_id | Create logger |
| delete | logger\_id | Delete logger |
| clear | logger\_id | Clear logged data |
### **get\_vpn\_profiles**
Retrieve VPN profiles for internal network scanning. Returns profile UUIDs for use with scanning tools.[****](https://pentest-toolscom-34533c73.mintlify.app/ai/mcp/tools-reference#resources)
## Resources
MCP resources provide read-only context to the LLM:
| **Resource** | **Description** |
| :---------------- | :------------------------------ |
| scans\:// | List of all scans |
| targets\:// | List of all targets |
| workspaces\:// | List of all workspaces |
| findings\:// | List of all findings (heavy) |
| reports\:// | List of all reports |
| http\_loggers\:// | List of all HTTP loggers |
| wordlists\:// | List of all available wordlists |
## Prompts
Ready-made MCP prompts with parameters
| **Name** | **Parameter** | **Prompt** |
| :--------- | :------------ | :------------------------------------------------------------------------------------------------------------------------ |
| pentest | target | Please provide a comprehensive pentesting report for this target: target, using the tools at your disposal. |
| subdomains | target | Please find all the subdomains that you can for this domain: target, using the tools at your disposal. |
| summary | workspace\_id | Please create an executive summary for the latest scans in the workspace workspace\_id, using the tools at your disposal. |