Alation · Capability

Alation Data Catalog API — Schemas

Alation Data Catalog API — Schemas. 2 operations. Lead operation: List schemas. Self-contained Naftiko capability covering one Alation business surface.

Run with Naftiko AlationSchemas

What You Can Do

GET
Listschemas — List schemas
/v1/schema
GET
Getschema — Get a schema
/v1/schema/{id}

MCP Tools

list-schemas

List schemas

read-only idempotent
get-schema

Get a schema

read-only idempotent

Capability Spec

data-catalog-schemas.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Alation Data Catalog API — Schemas
  description: 'Alation Data Catalog API — Schemas. 2 operations. Lead operation: List schemas. Self-contained Naftiko capability
    covering one Alation business surface.'
  tags:
  - Alation
  - Schemas
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ALATION_API_KEY: ALATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: data-catalog-schemas
    baseUri: https://{instance}/integration/v2
    description: Alation Data Catalog API — Schemas business capability. Self-contained, no shared references.
    resources:
    - name: schema
      path: /schema/
      operations:
      - name: listschemas
        method: GET
        description: List schemas
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ds_id
          in: query
          type: integer
          description: Data source ID to filter schemas
          required: true
        - name: limit
          in: query
          type: integer
        - name: skip
          in: query
          type: integer
    - name: schema-id
      path: /schema/{id}/
      operations:
      - name: getschema
        method: GET
        description: Get a schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.ALATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: data-catalog-schemas-rest
    port: 8080
    description: REST adapter for Alation Data Catalog API — Schemas. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/schema
      name: schema
      description: REST surface for schema.
      operations:
      - method: GET
        name: listschemas
        description: List schemas
        call: data-catalog-schemas.listschemas
        with:
          ds_id: rest.ds_id
          limit: rest.limit
          skip: rest.skip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/schema/{id}
      name: schema-id
      description: REST surface for schema-id.
      operations:
      - method: GET
        name: getschema
        description: Get a schema
        call: data-catalog-schemas.getschema
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: data-catalog-schemas-mcp
    port: 9090
    transport: http
    description: MCP adapter for Alation Data Catalog API — Schemas. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-schemas
      description: List schemas
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-catalog-schemas.listschemas
      with:
        ds_id: tools.ds_id
        limit: tools.limit
        skip: tools.skip
      outputParameters:
      - type: object
        mapping: $.
    - name: get-schema
      description: Get a schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-catalog-schemas.getschema
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.