Jina AI Reader API — Reader

naftiko: 1.0.0-alpha2
info:
  label: Jina AI Reader API — Reader
  description: 'Jina AI Reader API — Reader. 2 operations. Lead operation: Read a URL as LLM-friendly content. Self-contained
    Naftiko capability covering one Jina Ai business surface.'
  tags:
  - Jina Ai
  - Reader
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JINA_AI_API_KEY: JINA_AI_API_KEY
capability:
  consumes:
  - type: http
    namespace: reader-reader
    baseUri: https://r.jina.ai
    description: Jina AI Reader API — Reader business capability. Self-contained, no shared references.
    resources:
    - name: root
      path: /
      operations:
      - name: readurl
        method: POST
        description: Read a URL as LLM-friendly content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Engine
          in: header
          type: string
          description: Rendering engine
        - name: X-Return-Format
          in: header
          type: string
          description: Desired output format
        - name: X-With-Links-Summary
          in: header
          type: boolean
        - name: X-With-Images-Summary
          in: header
          type: boolean
        - name: X-With-Generated-Alt
          in: header
          type: boolean
        - name: X-Timeout
          in: header
          type: integer
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: url
      path: /{url}
      operations:
      - name: readurlbypath
        method: GET
        description: Read a URL via path
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: url
          in: path
          type: string
          description: Target URL to extract
          required: true
    authentication:
      type: bearer
      token: '{{env.JINA_AI_API_KEY}}'
  exposes:
  - type: rest
    namespace: reader-reader-rest
    port: 8080
    description: REST adapter for Jina AI Reader API — Reader. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1
      name: root
      description: REST surface for root.
      operations:
      - method: POST
        name: readurl
        description: Read a URL as LLM-friendly content
        call: reader-reader.readurl
        with:
          X-Engine: rest.X-Engine
          X-Return-Format: rest.X-Return-Format
          X-With-Links-Summary: rest.X-With-Links-Summary
          X-With-Images-Summary: rest.X-With-Images-Summary
          X-With-Generated-Alt: rest.X-With-Generated-Alt
          X-Timeout: rest.X-Timeout
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{url}
      name: url
      description: REST surface for url.
      operations:
      - method: GET
        name: readurlbypath
        description: Read a URL via path
        call: reader-reader.readurlbypath
        with:
          url: rest.url
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: reader-reader-mcp
    port: 9090
    transport: http
    description: MCP adapter for Jina AI Reader API — Reader. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: read-url-llm-friendly-content
      description: Read a URL as LLM-friendly content
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: reader-reader.readurl
      with:
        X-Engine: tools.X-Engine
        X-Return-Format: tools.X-Return-Format
        X-With-Links-Summary: tools.X-With-Links-Summary
        X-With-Images-Summary: tools.X-With-Images-Summary
        X-With-Generated-Alt: tools.X-With-Generated-Alt
        X-Timeout: tools.X-Timeout
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-url-path
      description: Read a URL via path
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: reader-reader.readurlbypath
      with:
        url: tools.url
      outputParameters:
      - type: object
        mapping: $.