examples.ts

import { ToolDefinition, ToolType, ParameterType } from './types';

export const nmapScannerExample: ToolDefinition = {
  name: 'nmap_scanner',
  type: ToolType.UTILITY,
  dependencies: 'python-nmap',
  functions: [
    {
      id: 'nmap-func-1',
      name: 'run_scan',
      description: 'Запускает сканирование Nmap на указанные цели с заданными аргументами. Позволяет выполнять гибкую разведку сети.',
      parameters: [
        {
          id: 'nmap-param-1',
          name: 'targets',
          type: ParameterType.STRING,
          description: "Цели для сканирования (IP, домен, CIDR). Например: '192.168.1.1', 'scanme.nmap.org', '10.0.0.0/24'.",
          required: true,
        },
        {
          id: 'nmap-param-2',
          name: 'ports',
          type: ParameterType.STRING,
          description: "Порты для сканирования. Например: '21-25,80,443,8080'.",
          required: true,
        },
        {
          id: 'nmap-param-3',
          name: 'arguments',
          type: ParameterType.STRING,
          description: "Дополнительные аргументы Nmap для тонкой настройки сканирования. Например: '-sV -sC -O'.",
          required: true,
        },
      ],
      returnType: ParameterType.DICTIONARY,
      returnDescription: 'Результат сканирования в формате JSON, содержащий информацию о хостах, портах, службах и их версиях.',
    },
    {
      id: 'nmap-func-2',
      name: 'host_discovery',
      description: 'Обнаруживает активные хосты в указанной сети (ping scan), не проводя сканирование портов.',
      parameters: [
        {
          id: 'nmap-param-4',
          name: 'network_cidr',
          type: ParameterType.STRING,
          description: "Сетевой диапазон в формате CIDR для обнаружения хостов. Например: '192.168.1.0/24'.",
          required: true,
        },
      ],
      returnType: ParameterType.LIST,
      returnDescription: 'Список IP-адресов активных хостов, обнаруженных в сети.',
    },
  ],
};