Couchbase · Capability

Couchbase Sync Gateway Public REST API — Local Documents

Couchbase Sync Gateway Public REST API — Local Documents. 3 operations. Lead operation: Get a local document. Self-contained Naftiko capability covering one Couchbase business surface.

Run with Naftiko CouchbaseLocal Documents

What You Can Do

GET

Getlocaldocument — Get a local document

/v1/{db}/local/{localdocid}

PUT

Putlocaldocument — Create or update a local document

/v1/{db}/local/{localdocid}

DELETE

Deletelocaldocument — Delete a local document

/v1/{db}/local/{localdocid}

MCP Tools

get-local-document

Get a local document

read-only idempotent

create-update-local-document

Create or update a local document

idempotent

delete-local-document

Delete a local document

idempotent

Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: Couchbase Sync Gateway Public REST API — Local Documents
  description: 'Couchbase Sync Gateway Public REST API — Local Documents. 3 operations. Lead operation: Get a local document.
    Self-contained Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Local Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COUCHBASE_API_KEY: COUCHBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: sync-gateway-public-rest-local-documents
    baseUri: https://localhost:4984
    description: Couchbase Sync Gateway Public REST API — Local Documents business capability. Self-contained, no shared references.
    resources:
    - name: db-_local-localDocId
      path: /{db}/_local/{localDocId}
      operations:
      - name: getlocaldocument
        method: GET
        description: Get a local document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: localDocId
          in: path
          type: string
          description: Local document ID
          required: true
      - name: putlocaldocument
        method: PUT
        description: Create or update a local document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: localDocId
          in: path
          type: string
          description: Local document ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletelocaldocument
        method: DELETE
        description: Delete a local document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: localDocId
          in: path
          type: string
          description: Local document ID
          required: true
        - name: rev
          in: query
          type: string
          description: Current revision of the local document
          required: true
    authentication:
      type: apikey
      key: SyncGatewaySession
      value: '{{env.COUCHBASE_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: sync-gateway-public-rest-local-documents-rest
    port: 8080
    description: REST adapter for Couchbase Sync Gateway Public REST API — Local Documents. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/{db}/local/{localdocid}
      name: db-local-localdocid
      description: REST surface for db-_local-localDocId.
      operations:
      - method: GET
        name: getlocaldocument
        description: Get a local document
        call: sync-gateway-public-rest-local-documents.getlocaldocument
        with:
          localDocId: rest.localDocId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putlocaldocument
        description: Create or update a local document
        call: sync-gateway-public-rest-local-documents.putlocaldocument
        with:
          localDocId: rest.localDocId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletelocaldocument
        description: Delete a local document
        call: sync-gateway-public-rest-local-documents.deletelocaldocument
        with:
          localDocId: rest.localDocId
          rev: rest.rev
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sync-gateway-public-rest-local-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Sync Gateway Public REST API — Local Documents. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-local-document
      description: Get a local document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sync-gateway-public-rest-local-documents.getlocaldocument
      with:
        localDocId: tools.localDocId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-update-local-document
      description: Create or update a local document
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sync-gateway-public-rest-local-documents.putlocaldocument
      with:
        localDocId: tools.localDocId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-local-document
      description: Delete a local document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sync-gateway-public-rest-local-documents.deletelocaldocument
      with:
        localDocId: tools.localDocId
        rev: tools.rev
      outputParameters:
      - type: object
        mapping: $.