Web of Science Starter API — documents

naftiko: 1.0.0-alpha2
info:
  label: Web of Science Starter API — documents
  description: 'Web of Science Starter API — documents. 2 operations. Lead operation: Web of Science Starter Search Documents.
    Self-contained Naftiko capability covering one Web Of Science Apis business surface.'
  tags:
  - Web Of Science Apis
  - documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEB_OF_SCIENCE_APIS_API_KEY: WEB_OF_SCIENCE_APIS_API_KEY
capability:
  consumes:
  - type: http
    namespace: web-of-science-starter-documents
    baseUri: https://api.clarivate.com/apis/wos-starter/v1
    description: Web of Science Starter API — documents business capability. Self-contained, no shared references.
    resources:
    - name: documents
      path: /documents
      operations:
      - name: searchdocuments
        method: GET
        description: Web of Science Starter Search Documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: Advanced query syntax string. Supports field tags such as TS (topic), AU (author), SO (source), DO
            (DOI), and others.
          required: true
        - name: db
          in: query
          type: string
          description: Database to search. Options include WOS, BIOABS, MEDLINE, etc. Defaults to WOS (Web of Science Core
            Collection).
        - name: limit
          in: query
          type: integer
          description: Number of records to return per page (1-50).
        - name: page
          in: query
          type: integer
          description: Page number for pagination.
        - name: sortField
          in: query
          type: string
          description: Field to sort results by.
        - name: publishTimeSpan
          in: query
          type: string
          description: Time span for publication date filter in format YYYY-MM-DD+YYYY-MM-DD.
        - name: modifiedTimeSpan
          in: query
          type: string
          description: Time span for last modified date filter in format YYYY-MM-DD+YYYY-MM-DD.
    - name: documents-uid
      path: /documents/{uid}
      operations:
      - name: getdocument
        method: GET
        description: Web of Science Starter Get Document by UID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uid
          in: path
          type: string
          description: Web of Science unique identifier (e.g., WOS:000000000000001).
          required: true
    authentication:
      type: apikey
      key: X-ApiKey
      value: '{{env.WEB_OF_SCIENCE_APIS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: web-of-science-starter-documents-rest
    port: 8080
    description: REST adapter for Web of Science Starter API — documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/documents
      name: documents
      description: REST surface for documents.
      operations:
      - method: GET
        name: searchdocuments
        description: Web of Science Starter Search Documents
        call: web-of-science-starter-documents.searchdocuments
        with:
          q: rest.q
          db: rest.db
          limit: rest.limit
          page: rest.page
          sortField: rest.sortField
          publishTimeSpan: rest.publishTimeSpan
          modifiedTimeSpan: rest.modifiedTimeSpan
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{uid}
      name: documents-uid
      description: REST surface for documents-uid.
      operations:
      - method: GET
        name: getdocument
        description: Web of Science Starter Get Document by UID
        call: web-of-science-starter-documents.getdocument
        with:
          uid: rest.uid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: web-of-science-starter-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Web of Science Starter API — documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: web-science-starter-search-documents
      description: Web of Science Starter Search Documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-of-science-starter-documents.searchdocuments
      with:
        q: tools.q
        db: tools.db
        limit: tools.limit
        page: tools.page
        sortField: tools.sortField
        publishTimeSpan: tools.publishTimeSpan
        modifiedTimeSpan: tools.modifiedTimeSpan
      outputParameters:
      - type: object
        mapping: $.
    - name: web-science-starter-get-document
      description: Web of Science Starter Get Document by UID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-of-science-starter-documents.getdocument
      with:
        uid: tools.uid
      outputParameters:
      - type: object
        mapping: $.