Skip to main content
Glama
intruder-io

intruder-mcp

Official

get_scan

Retrieve detailed results and status for a specific Intruder.IO security scan by providing its scan ID.

Instructions

    Get details of a specific scan.

    Args:
        scan_id: The ID of the scan to get
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scan_idYes

Implementation Reference

  • The @mcp.tool()-decorated handler function for 'get_scan'. It retrieves scan details from the IntruderAPI and formats them into a human-readable string.
    @mcp.tool()
    async def get_scan(scan_id: int) -> str:
        """
        Get details of a specific scan.
    
        Args:
            scan_id: The ID of the scan to get
        """
        scan = api.get_scan(scan_id)
        details = [
            f"Scan {scan.id} ({scan.scan_type})",
            f"Status: {scan.status}",
            f"Schedule: {scan.schedule_period}",
            f"Created: {scan.created_at}",
            f"Type: {scan.scan_type}"
        ]
        if scan.start_time:
            details.append(f"Started: {scan.start_time}")
        if scan.completed_time:
            details.append(f"Completed: {scan.completed_time}")
        if scan.target_addresses:
            details.append("\nTargets:")
            details.extend(f"- {addr}" for addr in scan.target_addresses)
    
        return "\n".join(details)
  • Helper method in IntruderAPI client that fetches the scan data via HTTP GET request to the Intruder API.
    def get_scan(self, scan_id: int) -> Scan:
        return Scan(**self.client.get(f"{self.base_url}/scans/{scan_id}/").json())
  • Pydantic BaseModel defining the structure of the Scan object used by get_scan.
    class Scan(BaseModel):
        id: int
        status: ScanStatusField
        created_at: datetime
        target_addresses: Optional[List[str]] = None
        scan_type: ScanTypeEnum
        schedule_period: SchedulePeriodEnum
        start_time: Optional[datetime] = None
        completed_time: Optional[datetime] = None
  • The @mcp.tool() decorator registers the get_scan function as an MCP tool.
    @mcp.tool()
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states it 'gets details' without specifying if this is a read-only operation, what permissions are needed, how errors are handled, or the format of returned details. For a tool with no annotation coverage, this is insufficient to inform the agent about its behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized with two sentences: one stating the purpose and another listing the parameter. It's front-loaded with the main function, and there's no wasted text, though the formatting with indentation and quotes is slightly verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a scan retrieval tool with no annotations and no output schema, the description is incomplete. It doesn't explain what details are returned, error conditions, or behavioral traits like rate limits. For a tool in a security/scanning context with siblings, more context is needed to guide the agent effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description includes an 'Args' section that documents the 'scan_id' parameter, adding meaning beyond the input schema which has 0% description coverage. This compensates partially, but since there's only one parameter and the schema coverage is low, the baseline is appropriate. However, it doesn't explain what a 'scan_id' is or provide examples.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Get details of a specific scan' which clearly indicates a retrieval operation on a scan resource, providing a basic verb+resource combination. However, it doesn't distinguish this tool from similar siblings like 'get_scanner_output' or 'get_status', nor does it specify what kind of details are retrieved, making it somewhat vague.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, when-not-to-use scenarios, or differentiate from sibling tools like 'list_scans' for multiple scans or 'get_scanner_output' for different data. This leaves the agent without context for tool selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/intruder-io/intruder-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server