ServiceNow CMDB Instance API — CMDB Instances

naftiko: 1.0.0-alpha2
info:
  label: ServiceNow CMDB Instance API — CMDB Instances
  description: 'ServiceNow CMDB Instance API — CMDB Instances. 2 operations. Lead operation: Servicenow List Configuration
    Items by Class. Self-contained Naftiko capability covering one Servicenow business surface.'
  tags:
  - Servicenow
  - CMDB Instances
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SERVICENOW_API_KEY: SERVICENOW_API_KEY
capability:
  consumes:
  - type: http
    namespace: cmdb-instance-cmdb-instances
    baseUri: https://{instance}.service-now.com/api/now/cmdb
    description: ServiceNow CMDB Instance API — CMDB Instances business capability. Self-contained, no shared references.
    resources:
    - name: instance-className
      path: /instance/{className}
      operations:
      - name: listcmdbinstances
        method: GET
        description: Servicenow List Configuration Items by Class
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: className
          in: path
          type: string
          description: The CMDB class name to query, such as cmdb_ci_server, cmdb_ci_linux_server, cmdb_ci_appl, or cmdb_ci_apache_web_server.
          required: true
        - name: sysparm_query
          in: query
          type: string
          description: An encoded query string to filter CI records.
        - name: sysparm_limit
          in: query
          type: integer
          description: Maximum number of records to return. Default is 1000.
        - name: sysparm_offset
          in: query
          type: integer
          description: Starting record index for pagination.
    - name: instance-className-sys_id
      path: /instance/{className}/{sys_id}
      operations:
      - name: getcmdbinstance
        method: GET
        description: Servicenow Retrieve a Specific Configuration Item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: className
          in: path
          type: string
          description: The CMDB class name.
          required: true
        - name: sys_id
          in: path
          type: string
          description: The unique sys_id of the configuration item.
          required: true
    authentication:
      type: bearer
      token: '{{env.SERVICENOW_API_KEY}}'
  exposes:
  - type: rest
    namespace: cmdb-instance-cmdb-instances-rest
    port: 8080
    description: REST adapter for ServiceNow CMDB Instance API — CMDB Instances. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/instance/{classname}
      name: instance-classname
      description: REST surface for instance-className.
      operations:
      - method: GET
        name: listcmdbinstances
        description: Servicenow List Configuration Items by Class
        call: cmdb-instance-cmdb-instances.listcmdbinstances
        with:
          className: rest.className
          sysparm_query: rest.sysparm_query
          sysparm_limit: rest.sysparm_limit
          sysparm_offset: rest.sysparm_offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/instance/{classname}/{sys-id}
      name: instance-classname-sys-id
      description: REST surface for instance-className-sys_id.
      operations:
      - method: GET
        name: getcmdbinstance
        description: Servicenow Retrieve a Specific Configuration Item
        call: cmdb-instance-cmdb-instances.getcmdbinstance
        with:
          className: rest.className
          sys_id: rest.sys_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cmdb-instance-cmdb-instances-mcp
    port: 9090
    transport: http
    description: MCP adapter for ServiceNow CMDB Instance API — CMDB Instances. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: servicenow-list-configuration-items-class
      description: Servicenow List Configuration Items by Class
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cmdb-instance-cmdb-instances.listcmdbinstances
      with:
        className: tools.className
        sysparm_query: tools.sysparm_query
        sysparm_limit: tools.sysparm_limit
        sysparm_offset: tools.sysparm_offset
      outputParameters:
      - type: object
        mapping: $.
    - name: servicenow-retrieve-specific-configuration-item
      description: Servicenow Retrieve a Specific Configuration Item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cmdb-instance-cmdb-instances.getcmdbinstance
      with:
        className: tools.className
        sys_id: tools.sys_id
      outputParameters:
      - type: object
        mapping: $.