Gremlin API — clients

naftiko: 1.0.0-alpha2
info:
  label: Gremlin API — clients
  description: 'Gremlin API — clients. 5 operations. Lead operation: Returns all clients within a team.. Self-contained Naftiko
    capability covering one Gremlin business surface.'
  tags:
  - Gremlin
  - clients
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GREMLIN_API_KEY: GREMLIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: gremlin-clients
    baseUri: https://api.gremlin.com/v1
    description: Gremlin API — clients business capability. Self-contained, no shared references.
    resources:
    - name: clients
      path: /clients
      operations:
      - name: all2
        method: GET
        description: Returns all clients within a team.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teamId
          in: query
          type: string
          description: The identifier of the team for which to retrieve clients
          required: true
    - name: clients-active
      path: /clients/active
      operations:
      - name: active2
        method: GET
        description: Return all active clients within a team
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teamId
          in: query
          type: string
          description: Required when using company session token.
          required: true
    - name: clients-identifier
      path: /clients/{identifier}
      operations:
      - name: getclientbyidentifier
        method: GET
        description: Get a client by identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: identifier
          in: path
          type: string
          description: The identifier of the client to get
          required: true
        - name: teamId
          in: query
          type: string
          description: Required when using company session token.
          required: true
      - name: revoke1
        method: DELETE
        description: Deactivate a client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: identifier
          in: path
          type: string
          description: The identifier of the client to revoke
          required: true
        - name: teamId
          in: query
          type: string
          description: Required when using company session token.
          required: true
    - name: clients-identifier-activate
      path: /clients/{identifier}/activate
      operations:
      - name: activate
        method: PUT
        description: Activate a client.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: identifier
          in: path
          type: string
          description: The identifier of the client to activate
          required: true
        - name: teamId
          in: query
          type: string
          description: Required when using company session token.
          required: true
  exposes:
  - type: rest
    namespace: gremlin-clients-rest
    port: 8080
    description: REST adapter for Gremlin API — clients. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/clients
      name: clients
      description: REST surface for clients.
      operations:
      - method: GET
        name: all2
        description: Returns all clients within a team.
        call: gremlin-clients.all2
        with:
          teamId: rest.teamId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/clients/active
      name: clients-active
      description: REST surface for clients-active.
      operations:
      - method: GET
        name: active2
        description: Return all active clients within a team
        call: gremlin-clients.active2
        with:
          teamId: rest.teamId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/clients/{identifier}
      name: clients-identifier
      description: REST surface for clients-identifier.
      operations:
      - method: GET
        name: getclientbyidentifier
        description: Get a client by identifier
        call: gremlin-clients.getclientbyidentifier
        with:
          identifier: rest.identifier
          teamId: rest.teamId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: revoke1
        description: Deactivate a client
        call: gremlin-clients.revoke1
        with:
          identifier: rest.identifier
          teamId: rest.teamId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/clients/{identifier}/activate
      name: clients-identifier-activate
      description: REST surface for clients-identifier-activate.
      operations:
      - method: PUT
        name: activate
        description: Activate a client.
        call: gremlin-clients.activate
        with:
          identifier: rest.identifier
          teamId: rest.teamId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: gremlin-clients-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gremlin API — clients. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: returns-all-clients-within-team
      description: Returns all clients within a team.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gremlin-clients.all2
      with:
        teamId: tools.teamId
      outputParameters:
      - type: object
        mapping: $.
    - name: return-all-active-clients-within
      description: Return all active clients within a team
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gremlin-clients.active2
      with:
        teamId: tools.teamId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-client-identifier
      description: Get a client by identifier
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gremlin-clients.getclientbyidentifier
      with:
        identifier: tools.identifier
        teamId: tools.teamId
      outputParameters:
      - type: object
        mapping: $.
    - name: deactivate-client
      description: Deactivate a client
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gremlin-clients.revoke1
      with:
        identifier: tools.identifier
        teamId: tools.teamId
      outputParameters:
      - type: object
        mapping: $.
    - name: activate-client
      description: Activate a client.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: gremlin-clients.activate
      with:
        identifier: tools.identifier
        teamId: tools.teamId
      outputParameters:
      - type: object
        mapping: $.