Materials Project API — Materials Phonon

naftiko: 1.0.0-alpha2
info:
  label: Materials Project API — Materials Phonon
  description: 'Materials Project API — Materials Phonon. 1 operations. Lead operation: Get PhononBSDOSDoc documents. Self-contained
    Naftiko capability covering one Materials Project business surface.'
  tags:
  - Materials Project
  - Materials Phonon
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MATERIALS_PROJECT_API_KEY: MATERIALS_PROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: materials-project-materials-phonon
    baseUri: ''
    description: Materials Project API — Materials Phonon business capability. Self-contained, no shared references.
    resources:
    - name: materials-phonon
      path: /materials/phonon/
      operations:
      - name: searchmaterialsphononget
        method: GET
        description: Get PhononBSDOSDoc documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: material_ids
          in: query
          type: string
          description: Comma-separated list of material_id values to query on
        - name: formula
          in: query
          type: string
          description: Query by formula including anonymized formula or by including wild cards. A comma delimited string
            list of anonymous formulas or regular formulas can also be pr
        - name: chemsys
          in: query
          type: string
          description: A comma delimited string list of chemical systems. Wildcards for unknown elements only supported for
            single chemsys queries
        - name: elements
          in: query
          type: string
          description: Query by elements in the material composition as a comma-separated list
        - name: exclude_elements
          in: query
          type: string
          description: Query by excluded elements in the material composition as a comma-separated list
        - name: crystal_system
          in: query
          type: string
          description: Crystal system of the material. If a comma-separated string, will query by multiple crystal systems.
        - name: spacegroup_number
          in: query
          type: string
          description: Space group number of the material. If a comma-separated string, will query by multiple space group
            numbers.
        - name: spacegroup_symbol
          in: query
          type: string
          description: Space group symbol of the material. If a comma-separated string, will query by multiple space group
            numbers.
        - name: phonon_method
          in: query
          type: string
          description: Phonon Method to search for
        - name: nsites_max
          in: query
          type: string
          description: Query for maximum value of nsites
        - name: nsites_min
          in: query
          type: string
          description: Query for minimum value of nsites
        - name: nsites
          in: query
          type: string
          description: Query for nsites being equal to an exact value
        - name: nsites_not_eq
          in: query
          type: string
          description: Query for nsites being not equal to an exact value
        - name: nsites_eq_any
          in: query
          type: string
          description: Query for nsites being any of these values. Provide a comma separated list.
        - name: nsites_neq_any
          in: query
          type: string
          description: Query for nsites being not any of these values.                             Provide a comma separated
            list.
        - name: nelements_max
          in: query
          type: string
          description: Query for maximum value of nelements
        - name: nelements_min
          in: query
          type: string
          description: Query for minimum value of nelements
        - name: nelements
          in: query
          type: string
          description: Query for nelements being equal to an exact value
        - name: nelements_not_eq
          in: query
          type: string
          description: Query for nelements being not equal to an exact value
        - name: nelements_eq_any
          in: query
          type: string
          description: Query for nelements being any of these values. Provide a comma separated list.
        - name: nelements_neq_any
          in: query
          type: string
          description: Query for nelements being not any of these values.                             Provide a comma separated
            list.
        - name: volume_max
          in: query
          type: string
          description: Query for maximum value of volume
        - name: volume_min
          in: query
          type: string
          description: Query for minimum value of volume
        - name: density_max
          in: query
          type: string
          description: Query for maximum value of density
        - name: density_min
          in: query
          type: string
          description: Query for minimum value of density
        - name: density_atomic_max
          in: query
          type: string
          description: Query for maximum value of density_atomic
        - name: density_atomic_min
          in: query
          type: string
          description: Query for minimum value of density_atomic
        - name: total_dft_energy_max
          in: query
          type: string
          description: Query for maximum value of total_dft_energy
        - name: total_dft_energy_min
          in: query
          type: string
          description: Query for minimum value of total_dft_energy
        - name: volume_per_formula_unit_max
          in: query
          type: string
          description: Query for maximum value of volume_per_formula_unit
        - name: volume_per_formula_unit_min
          in: query
          type: string
          description: Query for minimum value of volume_per_formula_unit
        - name: formula_units_max
          in: query
          type: string
          description: Query for maximum value of formula_units
        - name: formula_units_min
          in: query
          type: string
          description: Query for minimum value of formula_units
        - name: formula_units
          in: query
          type: string
          description: Query for formula_units being equal to an exact value
        - name: formula_units_not_eq
          in: query
          type: string
          description: Query for formula_units being not equal to an exact value
        - name: formula_units_eq_any
          in: query
          type: string
          description: Query for formula_units being any of these values. Provide a comma separated list.
        - name: formula_units_neq_any
          in: query
          type: string
          description: Query for formula_units being not any of these values.                             Provide a comma
            separated list.
        - name: _page
          in: query
          type: integer
          description: Page number to request (takes precedent over _limit and _skip).
        - name: _per_page
          in: query
          type: integer
          description: Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.
        - name: _skip
          in: query
          type: integer
          description: Number of entries to skip in the search.
        - name: _limit
          in: query
          type: integer
          description: Max number of entries to return in a single query. Limited to 1000.
        - name: _fields
          in: query
          type: string
          description: 'Fields to project from PhononBSDOSDoc as a list of comma separated strings.                    Fields
            include: `nsites` `elements` `nelements` `composition` `co'
        - name: _all_fields
          in: query
          type: boolean
          description: Include all fields.
    authentication:
      type: apikey
      key: X-API-KEY
      value: '{{env.MATERIALS_PROJECT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: materials-project-materials-phonon-rest
    port: 8080
    description: REST adapter for Materials Project API — Materials Phonon. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/materials/phonon
      name: materials-phonon
      description: REST surface for materials-phonon.
      operations:
      - method: GET
        name: searchmaterialsphononget
        description: Get PhononBSDOSDoc documents
        call: materials-project-materials-phonon.searchmaterialsphononget
        with:
          material_ids: rest.material_ids
          formula: rest.formula
          chemsys: rest.chemsys
          elements: rest.elements
          exclude_elements: rest.exclude_elements
          crystal_system: rest.crystal_system
          spacegroup_number: rest.spacegroup_number
          spacegroup_symbol: rest.spacegroup_symbol
          phonon_method: rest.phonon_method
          nsites_max: rest.nsites_max
          nsites_min: rest.nsites_min
          nsites: rest.nsites
          nsites_not_eq: rest.nsites_not_eq
          nsites_eq_any: rest.nsites_eq_any
          nsites_neq_any: rest.nsites_neq_any
          nelements_max: rest.nelements_max
          nelements_min: rest.nelements_min
          nelements: rest.nelements
          nelements_not_eq: rest.nelements_not_eq
          nelements_eq_any: rest.nelements_eq_any
          nelements_neq_any: rest.nelements_neq_any
          volume_max: rest.volume_max
          volume_min: rest.volume_min
          density_max: rest.density_max
          density_min: rest.density_min
          density_atomic_max: rest.density_atomic_max
          density_atomic_min: rest.density_atomic_min
          total_dft_energy_max: rest.total_dft_energy_max
          total_dft_energy_min: rest.total_dft_energy_min
          volume_per_formula_unit_max: rest.volume_per_formula_unit_max
          volume_per_formula_unit_min: rest.volume_per_formula_unit_min
          formula_units_max: rest.formula_units_max
          formula_units_min: rest.formula_units_min
          formula_units: rest.formula_units
          formula_units_not_eq: rest.formula_units_not_eq
          formula_units_eq_any: rest.formula_units_eq_any
          formula_units_neq_any: rest.formula_units_neq_any
          _page: rest._page
          _per_page: rest._per_page
          _skip: rest._skip
          _limit: rest._limit
          _fields: rest._fields
          _all_fields: rest._all_fields
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: materials-project-materials-phonon-mcp
    port: 9090
    transport: http
    description: MCP adapter for Materials Project API — Materials Phonon. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-phononbsdosdoc-documents
      description: Get PhononBSDOSDoc documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: materials-project-materials-phonon.searchmaterialsphononget
      with:
        material_ids: tools.material_ids
        formula: tools.formula
        chemsys: tools.chemsys
        elements: tools.elements
        exclude_elements: tools.exclude_elements
        crystal_system: tools.crystal_system
        spacegroup_number: tools.spacegroup_number
        spacegroup_symbol: tools.spacegroup_symbol
        phonon_method: tools.phonon_method
        nsites_max: tools.nsites_max
        nsites_min: tools.nsites_min
        nsites: tools.nsites
        nsites_not_eq: tools.nsites_not_eq
        nsites_eq_any: tools.nsites_eq_any
        nsites_neq_any: tools.nsites_neq_any
        nelements_max: tools.nelements_max
        nelements_min: tools.nelements_min
        nelements: tools.nelements
        nelements_not_eq: tools.nelements_not_eq
        nelements_eq_any: tools.nelements_eq_any
        nelements_neq_any: tools.nelements_neq_any
        volume_max: tools.volume_max
        volume_min: tools.volume_min
        density_max: tools.density_max
        density_min: tools.density_min
        density_atomic_max: tools.density_atomic_max
        density_atomic_min: tools.density_atomic_min
        total_dft_energy_max: tools.total_dft_energy_max
        total_dft_energy_min: tools.total_dft_energy_min
        volume_per_formula_unit_max: tools.volume_per_formula_unit_max
        volume_per_formula_unit_min: tools.volume_per_formula_unit_min
        formula_units_max: tools.formula_units_max
        formula_units_min: tools.formula_units_min
        formula_units: tools.formula_units
        formula_units_not_eq: tools.formula_units_not_eq
        formula_units_eq_any: tools.formula_units_eq_any
        formula_units_neq_any: tools.formula_units_neq_any
        _page: tools._page
        _per_page: tools._per_page
        _skip: tools._skip
        _limit: tools._limit
        _fields: tools._fields
        _all_fields: tools._all_fields
      outputParameters:
      - type: object
        mapping: $.