Couchbase · Capability

Couchbase Server REST API — Cluster

Couchbase Server REST API — Cluster. 2 operations. Lead operation: Get cluster information. Self-contained Naftiko capability covering one Couchbase business surface.

Run with Naftiko CouchbaseCluster

What You Can Do

GET
Getpools — Get cluster information
/v1/pools
GET
Getpooldefault — Get default pool details
/v1/pools/default

MCP Tools

get-cluster-information

Get cluster information

read-only idempotent
get-default-pool-details

Get default pool details

read-only idempotent

Capability Spec

server-rest-cluster.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Couchbase Server REST API — Cluster
  description: 'Couchbase Server REST API — Cluster. 2 operations. Lead operation: Get cluster information. Self-contained
    Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Cluster
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COUCHBASE_API_KEY: COUCHBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: server-rest-cluster
    baseUri: https://localhost:8091
    description: Couchbase Server REST API — Cluster business capability. Self-contained, no shared references.
    resources:
    - name: pools
      path: /pools
      operations:
      - name: getpools
        method: GET
        description: Get cluster information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: pools-default
      path: /pools/default
      operations:
      - name: getpooldefault
        method: GET
        description: Get default pool details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.COUCHBASE_USER}}'
      password: '{{env.COUCHBASE_PASS}}'
  exposes:
  - type: rest
    namespace: server-rest-cluster-rest
    port: 8080
    description: REST adapter for Couchbase Server REST API — Cluster. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/pools
      name: pools
      description: REST surface for pools.
      operations:
      - method: GET
        name: getpools
        description: Get cluster information
        call: server-rest-cluster.getpools
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pools/default
      name: pools-default
      description: REST surface for pools-default.
      operations:
      - method: GET
        name: getpooldefault
        description: Get default pool details
        call: server-rest-cluster.getpooldefault
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-rest-cluster-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Server REST API — Cluster. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-cluster-information
      description: Get cluster information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-rest-cluster.getpools
      outputParameters:
      - type: object
        mapping: $.
    - name: get-default-pool-details
      description: Get default pool details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-rest-cluster.getpooldefault
      outputParameters:
      - type: object
        mapping: $.