VA Forms API — Forms

naftiko: 1.0.0-alpha2
info:
  label: VA Forms API — Forms
  description: 'VA Forms API — Forms. 2 operations. Lead operation: List VA forms. Self-contained Naftiko capability covering
    one Department Of Veterans Affairs business surface.'
  tags:
  - Department Of Veterans Affairs
  - Forms
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DEPARTMENT_OF_VETERANS_AFFAIRS_API_KEY: DEPARTMENT_OF_VETERANS_AFFAIRS_API_KEY
capability:
  consumes:
  - type: http
    namespace: va-forms-forms
    baseUri: https://sandbox-api.va.gov/services/va_forms/v0
    description: VA Forms API — Forms business capability. Self-contained, no shared references.
    resources:
    - name: forms
      path: /forms
      operations:
      - name: listforms
        method: GET
        description: List VA forms
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: Search query against form name or title
    - name: forms-form_name
      path: /forms/{form_name}
      operations:
      - name: getform
        method: GET
        description: Retrieve a single VA form
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: form_name
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: apikey
      value: '{{env.DEPARTMENT_OF_VETERANS_AFFAIRS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: va-forms-forms-rest
    port: 8080
    description: REST adapter for VA Forms API — Forms. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/forms
      name: forms
      description: REST surface for forms.
      operations:
      - method: GET
        name: listforms
        description: List VA forms
        call: va-forms-forms.listforms
        with:
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/forms/{form-name}
      name: forms-form-name
      description: REST surface for forms-form_name.
      operations:
      - method: GET
        name: getform
        description: Retrieve a single VA form
        call: va-forms-forms.getform
        with:
          form_name: rest.form_name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: va-forms-forms-mcp
    port: 9090
    transport: http
    description: MCP adapter for VA Forms API — Forms. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-va-forms
      description: List VA forms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: va-forms-forms.listforms
      with:
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-single-va-form
      description: Retrieve a single VA form
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: va-forms-forms.getform
      with:
        form_name: tools.form_name
      outputParameters:
      - type: object
        mapping: $.