# This file is automatically generated by ravepipeline::mcptool_build(). 
# Please never edit this file by hand!
name: ieegio-mcp_tool_surface_list
description: List all surfaces currently cached in session state. Returns basic metadata
  for each cached surface including its ID, reference paths, original format, and
  contents. This helps track which surfaces are available for use by other MCP tools.
parameters:
  type: object
  properties: {}
category: info
returns:
  type: object
  properties:
    error:
      type: string
      description: Character, error message if success is FALSE
    surfaces:
      type: array
      description: 'List of surface metadata, each containing: id{Character, surface
        identifier} paths{Character vector, file paths associated with this surface}
        format{Character, original format ("gifti", "stl", or "freesurfer")} contains{Character
        vector, data types contained (e.g., "geometry", "measurements")} }'
      items:
        type: string
    count:
      type: integer
      description: Integer, number of cached surfaces
    success:
      type: boolean
      description: Logical, whether the operation completed successfully
implementation_example: |
  # Read multiple surfaces and list them
  # Note: .state_env is automatically provided when called via MCP.
  # AI does not need to specify this argument. The examples only use
  # .state_env to make the code runnable for demonstration purposes.
  state_env <- fastmap::fastmap()
  file1 <- ieegio_sample_data("gifti/GzipBase64/sujet01_Lwhite.surf.gii")
  ieegio:::mcp_tool_surface_read(file1, .state_env = state_env)
  file2 <- ieegio_sample_data("gifti/GzipBase64/sujet01_Lwhite.shape.gii")
  ieegio:::mcp_tool_surface_read(file2, .state_env = state_env)
  # List all cached surfaces
  ieegio:::mcp_tool_surface_list(.state_env = state_env)
  #
  #> $success
  #> [1] TRUE
  #> 
  #> $count
  #> [1] 2
  #> 
  #> $surfaces
  #> $surfaces[[1]]
  #> $surfaces[[1]]$id
  #> [1] "87405ad0bc7df5262dadebee27bf4c3b"
  #> 
  #> $surfaces[[1]]$paths
  #> [1] "/Users/dipterix/Library/Caches/org.R-project.R/R/ieegio/sample_data/gifti/GzipBase64/sujet01_Lwhite.surf.gii"
  #> 
  #> $surfaces[[1]]$format
  #> [1] "gifti"
  #> 
  #> $surfaces[[1]]$contains
  #> [1] "geometry"
  #> 
  #> 
  #> $surfaces[[2]]
  #> $surfaces[[2]]$id
  #> [1] "51679d5e55d52322897e1a6846a87ed4"
  #> 
  #> $surfaces[[2]]$paths
  #> [1] "/Users/dipterix/Library/Caches/org.R-project.R/R/ieegio/sample_data/gifti/GzipBase64/sujet01_Lwhite.shape.gii"
  #> 
  #> $surfaces[[2]]$format
  #> [1] "gifti"
  #> 
  #> $surfaces[[2]]$contains
  #> [1] "measurements"
  #> 
  #> 
  #>
execution_time: 0.024
