Coveo · Capability
Coveo Source API — Salesforce Source Configuration

Coveo Source API — Salesforce Source Configuration. 10 operations. Lead operation: Generate an ObjectsToGet Given a Schema. Self-contained Naftiko capability covering one Coveo business surface.
Run with Naftiko CoveoSourceSalesforce Source Configuration
What You Can Do

POST
Generateotg — Generate an ObjectsToGet Given a Schema
/v1/sourceconfiguration/salesforce/generateotg
GET
Getdefaultobjects — Get Objects
/v1/sourceconfiguration/salesforce/objects
POST
Refreshobjects — Refresh Objects
/v1/sourceconfiguration/salesforce/objects
GET
Getobject — Get the Information for a Given Object
/v1/sourceconfiguration/salesforce/objects/{objectname}
GET
Getfields — Get Fields for a Given Object
/v1/sourceconfiguration/salesforce/objects/{objectname}/fields
POST
Refreshfields — Refresh Fields for a Given Object
/v1/sourceconfiguration/salesforce/objects/{objectname}/fields
GET
Getrelationship — Get the Information for a Given Object Relationship
/v1/sourceconfiguration/salesforce/objects/{objectname}/{relationshipname}
POST
Parseotg — Parse an ObjectsToGet to a Schema
/v1/sourceconfiguration/salesforce/parseotg
GET
Getschema — Get Complete Schema (objects and Fields)
/v1/sourceconfiguration/salesforce/schema
POST
Refreshschema — Refresh Complete Schema (objects and Fields)
/v1/sourceconfiguration/salesforce/schema
MCP Tools

generate-objectstoget-given-schema

Generate an ObjectsToGet Given a Schema
read-only
get-objects

Get Objects
read-only idempotent
refresh-objects

Refresh Objects
get-information-given-object

Get the Information for a Given Object
read-only idempotent
get-fields-given-object

Get Fields for a Given Object
read-only idempotent
refresh-fields-given-object

Refresh Fields for a Given Object
get-information-given-object-relationship

Get the Information for a Given Object Relationship
read-only idempotent
parse-objectstoget-schema

Parse an ObjectsToGet to a Schema
read-only
get-complete-schema-objects-and

Get Complete Schema (objects and Fields)
read-only idempotent
refresh-complete-schema-objects-and

Refresh Complete Schema (objects and Fields)
Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: Coveo Source API — Salesforce Source Configuration
  description: 'Coveo Source API — Salesforce Source Configuration. 10 operations. Lead operation: Generate an ObjectsToGet
    Given a Schema. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Source
  - Salesforce Source Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: source-salesforce-source-configuration
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Source API — Salesforce Source Configuration business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-sourceconfiguration-salesforce-generateOTG
      path: /rest/sourceconfiguration/salesforce/generateOTG
      operations:
      - name: generateotg
        method: POST
        description: Generate an ObjectsToGet Given a Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schemaVersion
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-sourceconfiguration-salesforce-objects
      path: /rest/sourceconfiguration/salesforce/objects
      operations:
      - name: getdefaultobjects
        method: GET
        description: Get Objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
        - name: serviceCloudIndexed
          in: query
          type: boolean
        - name: knowledgeIndexed
          in: query
          type: boolean
        - name: contentIndexed
          in: query
          type: boolean
        - name: chatterIndexed
          in: query
          type: boolean
        - name: cloudCrazeProductsIndexed
          in: query
          type: boolean
        - name: cloudCrazeOrdersIndexed
          in: query
          type: boolean
      - name: refreshobjects
        method: POST
        description: Refresh Objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-sourceconfiguration-salesforce-objects-objectName
      path: /rest/sourceconfiguration/salesforce/objects/{objectName}
      operations:
      - name: getobject
        method: GET
        description: Get the Information for a Given Object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectName
          in: path
          type: string
          required: true
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
    - name: rest-sourceconfiguration-salesforce-objects-objectName-fields
      path: /rest/sourceconfiguration/salesforce/objects/{objectName}/fields
      operations:
      - name: getfields
        method: GET
        description: Get Fields for a Given Object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectName
          in: path
          type: string
          required: true
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
      - name: refreshfields
        method: POST
        description: Refresh Fields for a Given Object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectName
          in: path
          type: string
          required: true
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-sourceconfiguration-salesforce-objects-objectName-relationshipName
      path: /rest/sourceconfiguration/salesforce/objects/{objectName}/{relationshipName}
      operations:
      - name: getrelationship
        method: GET
        description: Get the Information for a Given Object Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectName
          in: path
          type: string
          required: true
        - name: relationshipName
          in: path
          type: string
          required: true
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
    - name: rest-sourceconfiguration-salesforce-parseOTG
      path: /rest/sourceconfiguration/salesforce/parseOTG
      operations:
      - name: parseotg
        method: POST
        description: Parse an ObjectsToGet to a Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: schemaVersion
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-sourceconfiguration-salesforce-schema
      path: /rest/sourceconfiguration/salesforce/schema
      operations:
      - name: getschema
        method: GET
        description: Get Complete Schema (objects and Fields)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
        - name: serviceCloudIndexed
          in: query
          type: boolean
        - name: knowledgeIndexed
          in: query
          type: boolean
        - name: contentIndexed
          in: query
          type: boolean
        - name: chatterIndexed
          in: query
          type: boolean
        - name: cloudCrazeProductsIndexed
          in: query
          type: boolean
        - name: cloudCrazeOrdersIndexed
          in: query
          type: boolean
      - name: refreshschema
        method: POST
        description: Refresh Complete Schema (objects and Fields)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessToken
          in: query
          type: string
        - name: idUrl
          in: query
          type: string
        - name: refreshToken
          in: query
          type: string
        - name: refreshTokenGuid
          in: query
          type: string
        - name: schemaVersion
          in: query
          type: string
        - name: sandbox
          in: query
          type: boolean
        - name: serviceCloudIndexed
          in: query
          type: boolean
        - name: knowledgeIndexed
          in: query
          type: boolean
        - name: contentIndexed
          in: query
          type: boolean
        - name: chatterIndexed
          in: query
          type: boolean
        - name: cloudCrazeProductsIndexed
          in: query
          type: boolean
        - name: cloudCrazeOrdersIndexed
          in: query
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: source-salesforce-source-configuration-rest
    port: 8080
    description: REST adapter for Coveo Source API — Salesforce Source Configuration. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/sourceconfiguration/salesforce/generateotg
      name: rest-sourceconfiguration-salesforce-generateotg
      description: REST surface for rest-sourceconfiguration-salesforce-generateOTG.
      operations:
      - method: POST
        name: generateotg
        description: Generate an ObjectsToGet Given a Schema
        call: source-salesforce-source-configuration.generateotg
        with:
          schemaVersion: rest.schemaVersion
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sourceconfiguration/salesforce/objects
      name: rest-sourceconfiguration-salesforce-objects
      description: REST surface for rest-sourceconfiguration-salesforce-objects.
      operations:
      - method: GET
        name: getdefaultobjects
        description: Get Objects
        call: source-salesforce-source-configuration.getdefaultobjects
        with:
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
          serviceCloudIndexed: rest.serviceCloudIndexed
          knowledgeIndexed: rest.knowledgeIndexed
          contentIndexed: rest.contentIndexed
          chatterIndexed: rest.chatterIndexed
          cloudCrazeProductsIndexed: rest.cloudCrazeProductsIndexed
          cloudCrazeOrdersIndexed: rest.cloudCrazeOrdersIndexed
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: refreshobjects
        description: Refresh Objects
        call: source-salesforce-source-configuration.refreshobjects
        with:
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sourceconfiguration/salesforce/objects/{objectname}
      name: rest-sourceconfiguration-salesforce-objects-objectname
      description: REST surface for rest-sourceconfiguration-salesforce-objects-objectName.
      operations:
      - method: GET
        name: getobject
        description: Get the Information for a Given Object
        call: source-salesforce-source-configuration.getobject
        with:
          objectName: rest.objectName
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sourceconfiguration/salesforce/objects/{objectname}/fields
      name: rest-sourceconfiguration-salesforce-objects-objectname-fields
      description: REST surface for rest-sourceconfiguration-salesforce-objects-objectName-fields.
      operations:
      - method: GET
        name: getfields
        description: Get Fields for a Given Object
        call: source-salesforce-source-configuration.getfields
        with:
          objectName: rest.objectName
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: refreshfields
        description: Refresh Fields for a Given Object
        call: source-salesforce-source-configuration.refreshfields
        with:
          objectName: rest.objectName
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sourceconfiguration/salesforce/objects/{objectname}/{relationshipname}
      name: rest-sourceconfiguration-salesforce-objects-objectname-relationshipname
      description: REST surface for rest-sourceconfiguration-salesforce-objects-objectName-relationshipName.
      operations:
      - method: GET
        name: getrelationship
        description: Get the Information for a Given Object Relationship
        call: source-salesforce-source-configuration.getrelationship
        with:
          objectName: rest.objectName
          relationshipName: rest.relationshipName
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sourceconfiguration/salesforce/parseotg
      name: rest-sourceconfiguration-salesforce-parseotg
      description: REST surface for rest-sourceconfiguration-salesforce-parseOTG.
      operations:
      - method: POST
        name: parseotg
        description: Parse an ObjectsToGet to a Schema
        call: source-salesforce-source-configuration.parseotg
        with:
          schemaVersion: rest.schemaVersion
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sourceconfiguration/salesforce/schema
      name: rest-sourceconfiguration-salesforce-schema
      description: REST surface for rest-sourceconfiguration-salesforce-schema.
      operations:
      - method: GET
        name: getschema
        description: Get Complete Schema (objects and Fields)
        call: source-salesforce-source-configuration.getschema
        with:
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
          serviceCloudIndexed: rest.serviceCloudIndexed
          knowledgeIndexed: rest.knowledgeIndexed
          contentIndexed: rest.contentIndexed
          chatterIndexed: rest.chatterIndexed
          cloudCrazeProductsIndexed: rest.cloudCrazeProductsIndexed
          cloudCrazeOrdersIndexed: rest.cloudCrazeOrdersIndexed
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: refreshschema
        description: Refresh Complete Schema (objects and Fields)
        call: source-salesforce-source-configuration.refreshschema
        with:
          accessToken: rest.accessToken
          idUrl: rest.idUrl
          refreshToken: rest.refreshToken
          refreshTokenGuid: rest.refreshTokenGuid
          schemaVersion: rest.schemaVersion
          sandbox: rest.sandbox
          serviceCloudIndexed: rest.serviceCloudIndexed
          knowledgeIndexed: rest.knowledgeIndexed
          contentIndexed: rest.contentIndexed
          chatterIndexed: rest.chatterIndexed
          cloudCrazeProductsIndexed: rest.cloudCrazeProductsIndexed
          cloudCrazeOrdersIndexed: rest.cloudCrazeOrdersIndexed
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: source-salesforce-source-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Source API — Salesforce Source Configuration. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: generate-objectstoget-given-schema
      description: Generate an ObjectsToGet Given a Schema
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: source-salesforce-source-configuration.generateotg
      with:
        schemaVersion: tools.schemaVersion
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-objects
      description: Get Objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: source-salesforce-source-configuration.getdefaultobjects
      with:
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
        serviceCloudIndexed: tools.serviceCloudIndexed
        knowledgeIndexed: tools.knowledgeIndexed
        contentIndexed: tools.contentIndexed
        chatterIndexed: tools.chatterIndexed
        cloudCrazeProductsIndexed: tools.cloudCrazeProductsIndexed
        cloudCrazeOrdersIndexed: tools.cloudCrazeOrdersIndexed
      outputParameters:
      - type: object
        mapping: $.
    - name: refresh-objects
      description: Refresh Objects
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: source-salesforce-source-configuration.refreshobjects
      with:
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-information-given-object
      description: Get the Information for a Given Object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: source-salesforce-source-configuration.getobject
      with:
        objectName: tools.objectName
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
      outputParameters:
      - type: object
        mapping: $.
    - name: get-fields-given-object
      description: Get Fields for a Given Object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: source-salesforce-source-configuration.getfields
      with:
        objectName: tools.objectName
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
      outputParameters:
      - type: object
        mapping: $.
    - name: refresh-fields-given-object
      description: Refresh Fields for a Given Object
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: source-salesforce-source-configuration.refreshfields
      with:
        objectName: tools.objectName
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-information-given-object-relationship
      description: Get the Information for a Given Object Relationship
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: source-salesforce-source-configuration.getrelationship
      with:
        objectName: tools.objectName
        relationshipName: tools.relationshipName
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
      outputParameters:
      - type: object
        mapping: $.
    - name: parse-objectstoget-schema
      description: Parse an ObjectsToGet to a Schema
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: source-salesforce-source-configuration.parseotg
      with:
        schemaVersion: tools.schemaVersion
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-complete-schema-objects-and
      description: Get Complete Schema (objects and Fields)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: source-salesforce-source-configuration.getschema
      with:
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
        serviceCloudIndexed: tools.serviceCloudIndexed
        knowledgeIndexed: tools.knowledgeIndexed
        contentIndexed: tools.contentIndexed
        chatterIndexed: tools.chatterIndexed
        cloudCrazeProductsIndexed: tools.cloudCrazeProductsIndexed
        cloudCrazeOrdersIndexed: tools.cloudCrazeOrdersIndexed
      outputParameters:
      - type: object
        mapping: $.
    - name: refresh-complete-schema-objects-and
      description: Refresh Complete Schema (objects and Fields)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: source-salesforce-source-configuration.refreshschema
      with:
        accessToken: tools.accessToken
        idUrl: tools.idUrl
        refreshToken: tools.refreshToken
        refreshTokenGuid: tools.refreshTokenGuid
        schemaVersion: tools.schemaVersion
        sandbox: tools.sandbox
        serviceCloudIndexed: tools.serviceCloudIndexed
        knowledgeIndexed: tools.knowledgeIndexed
        contentIndexed: tools.contentIndexed
        chatterIndexed: tools.chatterIndexed
        cloudCrazeProductsIndexed: tools.cloudCrazeProductsIndexed
        cloudCrazeOrdersIndexed: tools.cloudCrazeOrdersIndexed
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.