Factset VRS API documentation — Reports

naftiko: 1.0.0-alpha2
info:
  label: Factset VRS API documentation — Reports
  description: 'Factset VRS API documentation — Reports. 2 operations. Lead operation: Factset Gets all report definitions.
    Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: vermilion-reports-2
    baseUri: ''
    description: Factset VRS API documentation — Reports business capability. Self-contained, no shared references.
    resources:
    - name: v1-tenant-reports
      path: /v1/{tenant}/reports
      operations:
      - name: getallreportdefinitions
        method: GET
        description: Factset Gets all report definitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant
          in: path
          type: string
          description: The code of the tenancy
          required: true
        - name: _sort
          in: query
          type: array
          description: The column to sort on. Can add - to sort
        - name: _paginationLimit
          in: query
          type: integer
          description: Non-negative maximum number of entries to return
        - name: _paginationOffset
          in: query
          type: integer
          description: Non-negative number of entries to skip
    - name: v1-tenant-reports-reportDefinitionCode
      path: /v1/{tenant}/reports/{reportDefinitionCode}
      operations:
      - name: getreportdefinitionbycode
        method: GET
        description: Factset Gets a report definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant
          in: path
          type: string
          description: The code of the tenancy
          required: true
        - name: reportDefinitionCode
          in: path
          type: string
          description: The code of the report definition
          required: true
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: vermilion-reports-2-rest
    port: 8080
    description: REST adapter for Factset VRS API documentation — Reports. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/{tenant}/reports
      name: v1-tenant-reports
      description: REST surface for v1-tenant-reports.
      operations:
      - method: GET
        name: getallreportdefinitions
        description: Factset Gets all report definitions
        call: vermilion-reports-2.getallreportdefinitions
        with:
          tenant: rest.tenant
          _sort: rest._sort
          _paginationLimit: rest._paginationLimit
          _paginationOffset: rest._paginationOffset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/{tenant}/reports/{reportdefinitioncode}
      name: v1-tenant-reports-reportdefinitioncode
      description: REST surface for v1-tenant-reports-reportDefinitionCode.
      operations:
      - method: GET
        name: getreportdefinitionbycode
        description: Factset Gets a report definition
        call: vermilion-reports-2.getreportdefinitionbycode
        with:
          tenant: rest.tenant
          reportDefinitionCode: rest.reportDefinitionCode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vermilion-reports-2-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset VRS API documentation — Reports. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-gets-all-report-definitions
      description: Factset Gets all report definitions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vermilion-reports-2.getallreportdefinitions
      with:
        tenant: tools.tenant
        _sort: tools._sort
        _paginationLimit: tools._paginationLimit
        _paginationOffset: tools._paginationOffset
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-gets-report-definition
      description: Factset Gets a report definition
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vermilion-reports-2.getreportdefinitionbycode
      with:
        tenant: tools.tenant
        reportDefinitionCode: tools.reportDefinitionCode
      outputParameters:
      - type: object
        mapping: $.