FINRA Developer Center API — Metadata

naftiko: 1.0.0-alpha2
info:
  label: FINRA Developer Center API — Metadata
  description: 'FINRA Developer Center API — Metadata. 1 operations. Lead operation: Get dataset metadata. Self-contained
    Naftiko capability covering one Regulatory business surface.'
  tags:
  - Regulatory
  - Metadata
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    REGULATORY_API_KEY: REGULATORY_API_KEY
capability:
  consumes:
  - type: http
    namespace: regulatory-metadata
    baseUri: https://api.finra.org
    description: FINRA Developer Center 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: Get dataset metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.REGULATORY_API_KEY}}'
  exposes:
  - type: rest
    namespace: regulatory-metadata-rest
    port: 8080
    description: REST adapter for FINRA Developer Center 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: Get dataset metadata
        call: regulatory-metadata.getdatasetmetadata
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: regulatory-metadata-mcp
    port: 9090
    transport: http
    description: MCP adapter for FINRA Developer Center API — Metadata. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-dataset-metadata
      description: Get dataset metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: regulatory-metadata.getdatasetmetadata
      outputParameters:
      - type: object
        mapping: $.