Bright Data Web Unlocker

naftiko: 1.0.0-alpha2
info:
  label: Bright Data Web Unlocker
  description: |
    Bright Data Web Unlocker capability. Submit a URL and receive the fully unlocked page in
    synchronous mode, or submit and poll in async mode. Self-contained Naftiko capability covering
    one Bright Data business surface.
  tags:
  - Bright Data
  - Web Unlocker
  - Unblocking
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    BRIGHTDATA_API_TOKEN: BRIGHTDATA_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: web-unlocker
    baseUri: https://api.brightdata.com
    description: Bright Data Web Unlocker business capability.
    resources:
    - name: request
      path: /request
      operations:
      - name: unlockSync
        method: POST
        description: Synchronously unlock a target URL.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: '{ url, zone, country?, format?, method?, data? }'
          required: true
    - name: unblocker-req
      path: /unblocker/req
      operations:
      - name: unlockAsync
        method: POST
        description: Submit an asynchronous unlock request.
        outputRawFormat: json
        outputParameters:
        - name: response_id
          type: string
          value: $.response_id
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: unblocker-result
      path: /unblocker/get_result
      operations:
      - name: getUnlockResult
        method: GET
        description: Fetch the result of an asynchronous unlock request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: response_id
          in: query
          type: string
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: 'Bearer {{env.BRIGHTDATA_API_TOKEN}}'
      placement: header
  exposes:
  - type: mcp
    namespace: web-unlocker-mcp
    port: 9090
    transport: http
    description: MCP adapter for Bright Data Web Unlocker.
    tools:
    - name: bright-data-unlock-url
      description: Unlock a URL via Bright Data Web Unlocker (synchronous).
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: web-unlocker.unlockSync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bright-data-unlock-url-async
      description: Submit an async unlock and poll until complete.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: web-unlocker.unlockAsync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.