Skip to main content
Glama
intruder-io

intruder-mcp

Official

get_scan

Retrieve details of a specific 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

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The MCP tool handler for 'get_scan'. It is decorated with @mcp.tool(), takes a scan_id parameter, calls api.get_scan(scan_id), and returns formatted scan details (id, type, status, schedule, created_at, start_time, completed_time, target_addresses).
    @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)
  • The API client helper method 'get_scan' that actually makes the HTTP GET request to /scans/{scan_id}/ and returns a Scan pydantic model.
    def get_scan(self, scan_id: int) -> Scan:
        return Scan(**self.client.get(f"{self.base_url}/scans/{scan_id}/").json())
  • The 'Scan' pydantic model schema used to deserialize the API response. Contains fields: id, status, created_at, target_addresses, scan_type, schedule_period, start_time, completed_time.
    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
Behavior2/5

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

No annotations are provided, and the description does not disclose any behavioral traits. It does not state that the operation is read-only, what happens if the scan does not exist, or any side effects. The output is not described, leaving the agent to infer from the output schema alone.

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

Conciseness5/5

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

The description is extremely concise with two sentences that directly state the purpose and parameter. No extraneous information is present.

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

Completeness3/5

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

For a simple tool with one parameter and an output schema, the description is adequate but lacks context about what 'details' includes. It could mention that the output schema provides scan details. The brevity is acceptable but leaves room for improvement.

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

Parameters4/5

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

The description explicitly documents the parameter 'scan_id: The ID of the scan to get', adding semantic meaning beyond the input schema's type and title. With 0% schema description coverage, this compensates well by clarifying the parameter's role.

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

Purpose5/5

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

The description clearly states 'Get details of a specific scan' with a specific verb and resource. It distinguishes from sibling tools like list_scans (lists all scans) and cancel_scan (cancels), making the purpose unambiguous.

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?

No guidance is provided on when to use this tool versus alternatives. It does not mention that for listing scans, list_scans should be used, nor does it specify any preconditions or exclusions.

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