Couchbase · Capability

Couchbase Server REST API — Nodes

Couchbase Server REST API — Nodes. 4 operations. Lead operation: Add a node to the cluster. Self-contained Naftiko capability covering one Couchbase business surface.

Run with Naftiko CouchbaseNodes

What You Can Do

POST
Addnode — Add a node to the cluster
/v1/controller/addnode
POST
Failovernode — Fail over a node
/v1/controller/failover
POST
Rebalancecluster — Rebalance the cluster
/v1/controller/rebalance
GET
Getnodes — Get nodes information
/v1/pools/nodes

MCP Tools

add-node-cluster

Add a node to the cluster

fail-over-node

Fail over a node

rebalance-cluster

Rebalance the cluster

get-nodes-information

Get nodes information

read-only idempotent

Capability Spec

server-rest-nodes.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Couchbase Server REST API — Nodes
  description: 'Couchbase Server REST API — Nodes. 4 operations. Lead operation: Add a node to the cluster. Self-contained
    Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Nodes
  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-nodes
    baseUri: https://localhost:8091
    description: Couchbase Server REST API — Nodes business capability. Self-contained, no shared references.
    resources:
    - name: controller-addNode
      path: /controller/addNode
      operations:
      - name: addnode
        method: POST
        description: Add a node to the cluster
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: controller-failOver
      path: /controller/failOver
      operations:
      - name: failovernode
        method: POST
        description: Fail over a node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: controller-rebalance
      path: /controller/rebalance
      operations:
      - name: rebalancecluster
        method: POST
        description: Rebalance the cluster
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: pools-nodes
      path: /pools/nodes
      operations:
      - name: getnodes
        method: GET
        description: Get nodes information
        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-nodes-rest
    port: 8080
    description: REST adapter for Couchbase Server REST API — Nodes. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/controller/addnode
      name: controller-addnode
      description: REST surface for controller-addNode.
      operations:
      - method: POST
        name: addnode
        description: Add a node to the cluster
        call: server-rest-nodes.addnode
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/controller/failover
      name: controller-failover
      description: REST surface for controller-failOver.
      operations:
      - method: POST
        name: failovernode
        description: Fail over a node
        call: server-rest-nodes.failovernode
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/controller/rebalance
      name: controller-rebalance
      description: REST surface for controller-rebalance.
      operations:
      - method: POST
        name: rebalancecluster
        description: Rebalance the cluster
        call: server-rest-nodes.rebalancecluster
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pools/nodes
      name: pools-nodes
      description: REST surface for pools-nodes.
      operations:
      - method: GET
        name: getnodes
        description: Get nodes information
        call: server-rest-nodes.getnodes
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-rest-nodes-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Server REST API — Nodes. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: add-node-cluster
      description: Add a node to the cluster
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-rest-nodes.addnode
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fail-over-node
      description: Fail over a node
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-rest-nodes.failovernode
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rebalance-cluster
      description: Rebalance the cluster
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-rest-nodes.rebalancecluster
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-nodes-information
      description: Get nodes information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-rest-nodes.getnodes
      outputParameters:
      - type: object
        mapping: $.