FINRA Query API — Metadata

naftiko: 1.0.0-alpha2
info:
  label: FINRA Query API — Metadata
  description: 'FINRA Query API — Metadata. 1 operations. Lead operation: Retrieve dataset field definitions and metadata.
    Self-contained Naftiko capability covering one Finra business surface.'
  tags:
  - Finra
  - Metadata
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FINRA_API_KEY: FINRA_API_KEY
capability:
  consumes:
  - type: http
    namespace: finra-metadata
    baseUri: https://api.finra.org
    description: FINRA Query API — Metadata business capability. Self-contained, no shared references.
    resources:
    - name: metadata-group-group-name-dataset
      path: /metadata/group/{group}/name/{dataset}
      operations:
      - name: getdatasetmetadata
        method: GET
        description: Retrieve dataset field definitions and metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.FINRA_API_KEY}}'
  exposes:
  - type: rest
    namespace: finra-metadata-rest
    port: 8080
    description: REST adapter for FINRA Query API — Metadata. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/metadata/group/{group}/name/{dataset}
      name: metadata-group-group-name-dataset
      description: REST surface for metadata-group-group-name-dataset.
      operations:
      - method: GET
        name: getdatasetmetadata
        description: Retrieve dataset field definitions and metadata
        call: finra-metadata.getdatasetmetadata
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: finra-metadata-mcp
    port: 9090
    transport: http
    description: MCP adapter for FINRA Query API — Metadata. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: retrieve-dataset-field-definitions-and
      description: Retrieve dataset field definitions and metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: finra-metadata.getdatasetmetadata
      outputParameters:
      - type: object
        mapping: $.