USDA ERS ARMS Data API — Survey Data

naftiko: 1.0.0-alpha2
info:
  label: USDA ERS ARMS Data API — Survey Data
  description: 'USDA ERS ARMS Data API — Survey Data. 1 operations. Lead operation: Get ARMS Survey Data. Self-contained Naftiko
    capability covering one United States Department Of Agriculture business surface.'
  tags:
  - United States Department Of Agriculture
  - Survey Data
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNITED_STATES_DEPARTMENT_OF_AGRICULTURE_API_KEY: UNITED_STATES_DEPARTMENT_OF_AGRICULTURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: usda-ers-arms-survey-data
    baseUri: https://api.ers.usda.gov/data/arms
    description: USDA ERS ARMS Data API — Survey Data business capability. Self-contained, no shared references.
    resources:
    - name: surveydata
      path: /surveydata
      operations:
      - name: getsurveydata
        method: GET
        description: Get ARMS Survey Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api_key
          in: query
          type: string
          description: API key from api.data.gov
          required: true
        - name: year
          in: query
          type: integer
          description: Survey year (required)
          required: true
        - name: report
          in: query
          type: string
          description: Report name to retrieve data for
        - name: variable
          in: query
          type: string
          description: Specific variable code(s) to retrieve
        - name: state
          in: query
          type: string
          description: Two-letter state abbreviation or NATIONAL
    authentication:
      type: apikey
      key: api_key
      value: '{{env.UNITED_STATES_DEPARTMENT_OF_AGRICULTURE_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: usda-ers-arms-survey-data-rest
    port: 8080
    description: REST adapter for USDA ERS ARMS Data API — Survey Data. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/surveydata
      name: surveydata
      description: REST surface for surveydata.
      operations:
      - method: GET
        name: getsurveydata
        description: Get ARMS Survey Data
        call: usda-ers-arms-survey-data.getsurveydata
        with:
          api_key: rest.api_key
          year: rest.year
          report: rest.report
          variable: rest.variable
          state: rest.state
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usda-ers-arms-survey-data-mcp
    port: 9090
    transport: http
    description: MCP adapter for USDA ERS ARMS Data API — Survey Data. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-arms-survey-data
      description: Get ARMS Survey Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usda-ers-arms-survey-data.getsurveydata
      with:
        api_key: tools.api_key
        year: tools.year
        report: tools.report
        variable: tools.variable
        state: tools.state
      outputParameters:
      - type: object
        mapping: $.