# This file is automatically generated by ravepipeline::mcptool_build(). 
# Please never edit this file by hand!
name: ieegio-mcp_tool_surface_info
description: Retrieve detailed information and metadata for a cached surface without
  loading the full data. This is useful for inspecting surface properties, vertex
  counts, and what data types are available.
parameters:
  type: object
  properties:
    id:
      type: string
      description: 'The digest-based identifier of the cached surface. Example values:
        "a3f5e8d9c1b2", "f7e4b2a1c6d8"'
      examples:
      - a3f5e8d9c1b2
      - f7e4b2a1c6d8
  required:
  - id
category: info
returns:
  type: object
  properties:
    error:
      type: string
      description: Character, error message if success is FALSE
    sparse:
      type: boolean
      description: Logical, whether surface uses sparse indexing
    n_faces:
      type: integer
      description: Integer, number of faces (if geometry present)
    n_vertices:
      type: integer
      description: Integer, number of vertices (if geometry present)
    contains:
      type: array
      description: Character vector, data types contained
      items:
        type: string
    format:
      type: string
      description: Character, original file format ("gifti", "stl", or "freesurfer")
    paths:
      type: array
      description: Character vector, file paths associated with this surface
      items:
        type: string
    id:
      type: string
      description: Character, the surface identifier
    success:
      type: boolean
      description: Logical, whether the operation completed successfully
implementation_example: |
  # Read a surface and get detailed info
  # 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.
  sample_file <- ieegio_sample_data("gifti/GzipBase64/sujet01_Lwhite.surf.gii")
  state_env <- fastmap::fastmap()
  read_result <- ieegio:::mcp_tool_surface_read(sample_file, .state_env = state_env)
  # Get detailed information
  ieegio:::mcp_tool_surface_info(id = read_result$id, .state_env = state_env)
  #
  #> $success
  #> [1] TRUE
  #> 
  #> $id
  #> [1] "87405ad0bc7df5262dadebee27bf4c3b"
  #> 
  #> $paths
  #> [1] "/Users/dipterix/Library/Caches/org.R-project.R/R/ieegio/sample_data/gifti/GzipBase64/sujet01_Lwhite.surf.gii"
  #> 
  #> $format
  #> [1] "gifti"
  #> 
  #> $contains
  #> [1] "geometry"
  #> 
  #>  [ reached 'max' / getOption("max.print") -- omitted 3 entries ]
execution_time: 0.016
