naftiko: 1.0.0-alpha2
info:
  label: FINRA Developer Center API — Data
  description: 'FINRA Developer Center API — Data. 3 operations. Lead operation: Query dataset (simple). Self-contained Naftiko
    capability covering one Regulatory business surface.'
  tags:
  - Regulatory
  - Data
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    REGULATORY_API_KEY: REGULATORY_API_KEY
capability:
  consumes:
  - type: http
    namespace: regulatory-data
    baseUri: https://api.finra.org
    description: FINRA Developer Center API — Data business capability. Self-contained, no shared references.
    resources:
    - name: data-group-group-name-dataset
      path: /data/group/{group}/name/{dataset}
      operations:
      - name: querydataset
        method: GET
        description: Query dataset (simple)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of records to return.
        - name: fields
          in: query
          type: string
          description: Comma-separated list of fields to return.
      - name: querydatasetadvanced
        method: POST
        description: Query dataset (advanced)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: data-group-group-name-dataset-id-id
      path: /data/group/{group}/name/{dataset}/id/{id}
      operations:
      - name: getdatasetrecordbyid
        method: GET
        description: Get dataset record by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Record identifier.
          required: true
    authentication:
      type: bearer
      token: '{{env.REGULATORY_API_KEY}}'
  exposes:
  - type: rest
    namespace: regulatory-data-rest
    port: 8080
    description: REST adapter for FINRA Developer Center API — Data. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/data/group/{group}/name/{dataset}
      name: data-group-group-name-dataset
      description: REST surface for data-group-group-name-dataset.
      operations:
      - method: GET
        name: querydataset
        description: Query dataset (simple)
        call: regulatory-data.querydataset
        with:
          limit: rest.limit
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: querydatasetadvanced
        description: Query dataset (advanced)
        call: regulatory-data.querydatasetadvanced
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data/group/{group}/name/{dataset}/id/{id}
      name: data-group-group-name-dataset-id-id
      description: REST surface for data-group-group-name-dataset-id-id.
      operations:
      - method: GET
        name: getdatasetrecordbyid
        description: Get dataset record by id
        call: regulatory-data.getdatasetrecordbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: regulatory-data-mcp
    port: 9090
    transport: http
    description: MCP adapter for FINRA Developer Center API — Data. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: query-dataset-simple
      description: Query dataset (simple)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: regulatory-data.querydataset
      with:
        limit: tools.limit
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: query-dataset-advanced
      description: Query dataset (advanced)
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: regulatory-data.querydatasetadvanced
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-dataset-record-id
      description: Get dataset record by id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: regulatory-data.getdatasetrecordbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.