Materials Project API — Materials Chemical Environment

naftiko: 1.0.0-alpha2
info:
  label: Materials Project API — Materials Chemical Environment
  description: 'Materials Project API — Materials Chemical Environment. 1 operations. Lead operation: Get ChemEnvDoc documents.
    Self-contained Naftiko capability covering one Materials Project business surface.'
  tags:
  - Materials Project
  - Materials Chemical Environment
  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-chemical-environment
    baseUri: ''
    description: Materials Project API — Materials Chemical Environment business capability. Self-contained, no shared references.
    resources:
    - name: materials-chemenv
      path: /materials/chemenv/
      operations:
      - name: searchmaterialschemenvget
        method: GET
        description: Get ChemEnvDoc 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: chemenv_iucr
          in: query
          type: string
          description: A comma delimited string list of unique (cationic) species in IUCR format.
        - name: chemenv_iupac
          in: query
          type: string
          description: A comma delimited string list of unique (cationic) species in IUPAC format.
        - name: chemenv_name
          in: query
          type: string
          description: A comma delimited string list of coordination environment descriptions for unique (cationic) species.
        - name: chemenv_symbol
          in: query
          type: string
          description: A comma delimited string list of ChemEnv symbols for unique (cationic) species in the structure.
        - name: species
          in: query
          type: string
          description: A comma delimited string list of unique (cationic) species in the structure.
        - name: csm_min
          in: query
          type: string
          description: Minimum value of the continous symmetry measure for any site.
        - name: csm_max
          in: query
          type: string
          description: Maximum value of the continous symmetry measure for any site.
        - 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: 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: _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 ChemEnvDoc as a list of comma separated strings.                    Fields
            include: `builder_meta` `nsites` `elements` `nelements` `compo'
        - 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-chemical-environment-rest
    port: 8080
    description: REST adapter for Materials Project API — Materials Chemical Environment. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/materials/chemenv
      name: materials-chemenv
      description: REST surface for materials-chemenv.
      operations:
      - method: GET
        name: searchmaterialschemenvget
        description: Get ChemEnvDoc documents
        call: materials-project-materials-chemical-environment.searchmaterialschemenvget
        with:
          material_ids: rest.material_ids
          chemenv_iucr: rest.chemenv_iucr
          chemenv_iupac: rest.chemenv_iupac
          chemenv_name: rest.chemenv_name
          chemenv_symbol: rest.chemenv_symbol
          species: rest.species
          csm_min: rest.csm_min
          csm_max: rest.csm_max
          elements: rest.elements
          exclude_elements: rest.exclude_elements
          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
          _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-chemical-environment-mcp
    port: 9090
    transport: http
    description: MCP adapter for Materials Project API — Materials Chemical Environment. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-chemenvdoc-documents
      description: Get ChemEnvDoc documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: materials-project-materials-chemical-environment.searchmaterialschemenvget
      with:
        material_ids: tools.material_ids
        chemenv_iucr: tools.chemenv_iucr
        chemenv_iupac: tools.chemenv_iupac
        chemenv_name: tools.chemenv_name
        chemenv_symbol: tools.chemenv_symbol
        species: tools.species
        csm_min: tools.csm_min
        csm_max: tools.csm_max
        elements: tools.elements
        exclude_elements: tools.exclude_elements
        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
        _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: $.