Materials Project API — Materials Surface Properties

naftiko: 1.0.0-alpha2
info:
  label: Materials Project API — Materials Surface Properties
  description: 'Materials Project API — Materials Surface Properties. 1 operations. Lead operation: Get SurfacePropDoc documents.
    Self-contained Naftiko capability covering one Materials Project business surface.'
  tags:
  - Materials Project
  - Materials Surface Properties
  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-surface-properties
    baseUri: ''
    description: Materials Project API — Materials Surface Properties business capability. Self-contained, no shared references.
    resources:
    - name: materials-surface_properties
      path: /materials/surface_properties/
      operations:
      - name: searchmaterialssurfacepropertiesget
        method: GET
        description: Get SurfacePropDoc 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: weighted_surface_energy_EV_PER_ANG2_max
          in: query
          type: string
          description: Query for maximum value of weighted_surface_energy_EV_PER_ANG2
        - name: weighted_surface_energy_EV_PER_ANG2_min
          in: query
          type: string
          description: Query for minimum value of weighted_surface_energy_EV_PER_ANG2
        - name: weighted_surface_energy_max
          in: query
          type: string
          description: Query for maximum value of weighted_surface_energy
        - name: weighted_surface_energy_min
          in: query
          type: string
          description: Query for minimum value of weighted_surface_energy
        - name: surface_anisotropy_max
          in: query
          type: string
          description: Query for maximum value of surface_anisotropy
        - name: surface_anisotropy_min
          in: query
          type: string
          description: Query for minimum value of surface_anisotropy
        - name: shape_factor_max
          in: query
          type: string
          description: Query for maximum value of shape_factor
        - name: shape_factor_min
          in: query
          type: string
          description: Query for minimum value of shape_factor
        - name: weighted_work_function_max
          in: query
          type: string
          description: Query for maximum value of weighted_work_function
        - name: weighted_work_function_min
          in: query
          type: string
          description: Query for minimum value of weighted_work_function
        - name: has_reconstructed
          in: query
          type: string
          description: Whether the entry has a reconstructed surface.
        - 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 SurfacePropDoc as a list of comma separated strings.                    Fields
            include: `surfaces` `weighted_surface_energy_EV_PER_ANG2` '
        - 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-surface-properties-rest
    port: 8080
    description: REST adapter for Materials Project API — Materials Surface Properties. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/materials/surface-properties
      name: materials-surface-properties
      description: REST surface for materials-surface_properties.
      operations:
      - method: GET
        name: searchmaterialssurfacepropertiesget
        description: Get SurfacePropDoc documents
        call: materials-project-materials-surface-properties.searchmaterialssurfacepropertiesget
        with:
          material_ids: rest.material_ids
          weighted_surface_energy_EV_PER_ANG2_max: rest.weighted_surface_energy_EV_PER_ANG2_max
          weighted_surface_energy_EV_PER_ANG2_min: rest.weighted_surface_energy_EV_PER_ANG2_min
          weighted_surface_energy_max: rest.weighted_surface_energy_max
          weighted_surface_energy_min: rest.weighted_surface_energy_min
          surface_anisotropy_max: rest.surface_anisotropy_max
          surface_anisotropy_min: rest.surface_anisotropy_min
          shape_factor_max: rest.shape_factor_max
          shape_factor_min: rest.shape_factor_min
          weighted_work_function_max: rest.weighted_work_function_max
          weighted_work_function_min: rest.weighted_work_function_min
          has_reconstructed: rest.has_reconstructed
          _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-surface-properties-mcp
    port: 9090
    transport: http
    description: MCP adapter for Materials Project API — Materials Surface Properties. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: get-surfacepropdoc-documents
      description: Get SurfacePropDoc documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: materials-project-materials-surface-properties.searchmaterialssurfacepropertiesget
      with:
        material_ids: tools.material_ids
        weighted_surface_energy_EV_PER_ANG2_max: tools.weighted_surface_energy_EV_PER_ANG2_max
        weighted_surface_energy_EV_PER_ANG2_min: tools.weighted_surface_energy_EV_PER_ANG2_min
        weighted_surface_energy_max: tools.weighted_surface_energy_max
        weighted_surface_energy_min: tools.weighted_surface_energy_min
        surface_anisotropy_max: tools.surface_anisotropy_max
        surface_anisotropy_min: tools.surface_anisotropy_min
        shape_factor_max: tools.shape_factor_max
        shape_factor_min: tools.shape_factor_min
        weighted_work_function_max: tools.weighted_work_function_max
        weighted_work_function_min: tools.weighted_work_function_min
        has_reconstructed: tools.has_reconstructed
        _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: $.