NCBI E-utilities API — Retrieve

naftiko: 1.0.0-alpha2
info:
  label: NCBI E-utilities API — Retrieve
  description: 'NCBI E-utilities API — Retrieve. 2 operations. Lead operation: Fetch full records by UID. Self-contained Naftiko
    capability covering one National Library Of Medicine business surface.'
  tags:
  - National Library Of Medicine
  - Retrieve
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NATIONAL_LIBRARY_OF_MEDICINE_API_KEY: NATIONAL_LIBRARY_OF_MEDICINE_API_KEY
capability:
  consumes:
  - type: http
    namespace: national-library-of-medicine-retrieve
    baseUri: https://eutils.ncbi.nlm.nih.gov/entrez/eutils
    description: NCBI E-utilities API — Retrieve business capability. Self-contained, no shared references.
    resources:
    - name: efetch.fcgi
      path: /efetch.fcgi
      operations:
      - name: efetch
        method: GET
        description: Fetch full records by UID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: db
          in: query
          type: string
          required: true
        - name: id
          in: query
          type: string
          description: Comma-separated list of UIDs or a WebEnv/query_key reference.
          required: true
        - name: rettype
          in: query
          type: string
          description: Retrieval type (e.g. abstract, fasta, gb, medline).
        - name: retmode
          in: query
          type: string
          description: Retrieval mode (e.g. xml, text, json, asn.1).
        - name: api_key
          in: query
          type: string
    - name: esummary.fcgi
      path: /esummary.fcgi
      operations:
      - name: esummary
        method: GET
        description: Retrieve document summaries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: db
          in: query
          type: string
          required: true
        - name: id
          in: query
          type: string
          required: true
        - name: version
          in: query
          type: string
          description: Set to '2.0' for the newer DocSum schema.
        - name: retmode
          in: query
          type: string
  exposes:
  - type: rest
    namespace: national-library-of-medicine-retrieve-rest
    port: 8080
    description: REST adapter for NCBI E-utilities API — Retrieve. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/efetch-fcgi
      name: efetch-fcgi
      description: REST surface for efetch.fcgi.
      operations:
      - method: GET
        name: efetch
        description: Fetch full records by UID
        call: national-library-of-medicine-retrieve.efetch
        with:
          db: rest.db
          id: rest.id
          rettype: rest.rettype
          retmode: rest.retmode
          api_key: rest.api_key
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/esummary-fcgi
      name: esummary-fcgi
      description: REST surface for esummary.fcgi.
      operations:
      - method: GET
        name: esummary
        description: Retrieve document summaries
        call: national-library-of-medicine-retrieve.esummary
        with:
          db: rest.db
          id: rest.id
          version: rest.version
          retmode: rest.retmode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: national-library-of-medicine-retrieve-mcp
    port: 9090
    transport: http
    description: MCP adapter for NCBI E-utilities API — Retrieve. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: fetch-full-records-uid
      description: Fetch full records by UID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-library-of-medicine-retrieve.efetch
      with:
        db: tools.db
        id: tools.id
        rettype: tools.rettype
        retmode: tools.retmode
        api_key: tools.api_key
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-document-summaries
      description: Retrieve document summaries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-library-of-medicine-retrieve.esummary
      with:
        db: tools.db
        id: tools.id
        version: tools.version
        retmode: tools.retmode
      outputParameters:
      - type: object
        mapping: $.