pl_heatmap

Instructions

Implementation Reference

• src/scmcp/tool/pl.py:179-216 (handler)

  Generic handler function that executes the Scanpy plotting function for 'pl_heatmap' (sc.pl.heatmap) using validated input arguments from the schema, saves the figure, and logs the operation.

  def run_pl_func(ads, func, arguments):
      """
      Execute a Scanpy plotting function with the given arguments.
      
      Parameters
      ----------
      adata : AnnData
          Annotated data matrix.
      func : str
          Name of the plotting function to execute.
      arguments : dict
          Arguments to pass to the plotting function.
          
      Returns
      -------
      The result of the plotting function.
      """
      adata = ads.adata_dic[ads.active]
      if func not in pl_func:
          raise ValueError(f"Unsupported function: {func}")
  
      run_func = pl_func[func]
      parameters = inspect.signature(run_func).parameters
      kwargs = {k: arguments.get(k) for k in parameters if k in arguments}    
  
      if "title" not in parameters:
          kwargs.pop("title", False)    
      kwargs.pop("return_fig", True)
      kwargs["show"] = False
      kwargs["save"] = ".png"
      try:
          fig = run_func(adata, **kwargs)
          fig_path = set_fig_path(func, **kwargs)
          add_op_log(adata, run_func, kwargs)
          return fig_path 
      except Exception as e:
          raise e
      return fig_path

• src/scmcp/schema/pl.py:381-417 (schema)

  Pydantic model defining the input schema and validation for the pl_heatmap tool, extending BaseMatrixModel with specific heatmap parameters.

  # 重构 HeatmapModel
  class HeatmapModel(BaseMatrixModel):
      """Input schema for the heatmap plotting tool."""
      
      num_categories: int = Field(
          default=7,
          description="Only used if groupby observation is not categorical. This value determines the number of groups into which the groupby observation should be subdivided.",
          gt=0
      )
      
      var_group_rotation: Optional[float] = Field(
          default=None,
          description="Label rotation degrees. By default, labels larger than 4 characters are rotated 90 degrees."
      )
      
      standard_scale: Optional[Literal['var', 'obs']] = Field(
          default=None,
          description="Whether or not to standardize that dimension between 0 and 1."
      )
      
      swap_axes: bool = Field(
          default=False,
          description="By default, the x axis contains var_names and the y axis the groupby categories. By setting swap_axes then x are the groupby categories and y the var_names."
      )
      
      show_gene_labels: Optional[bool] = Field(
          default=None,
          description="By default gene labels are shown when there are 50 or less genes. Otherwise the labels are removed."
      )
      
      @field_validator('num_categories')
      def validate_num_categories(cls, v: int) -> int:
          """Validate num_categories is positive"""
          if v <= 0:
              raise ValueError("num_categories must be a positive integer")
          return v

• src/scmcp/tool/pl.py:42-46 (registration)

  Creation and definition of the pl_heatmap Tool object using MCP types, linking to the HeatmapModel schema.

  pl_heatmap = types.Tool(
      name="pl_heatmap",
      description="Heatmap of the expression values of genes.",
      inputSchema=HeatmapModel.model_json_schema(),
  )

• src/scmcp/tool/pl.py:121-138 (registration)

  Dictionary mapping pl_heatmap tool name to the underlying Scanpy function sc.pl.heatmap, used by the handler.

  pl_func = {
      "pl_pca": sc.pl.pca,
      "pl_embedding": sc.pl.embedding,  # Add the new embedding function
      "diffmap": sc.pl.diffmap,
      "pl_violin": sc.pl.violin,
      "pl_stacked_violin": sc.pl.stacked_violin,
      "pl_heatmap": sc.pl.heatmap,
      "pl_dotplot": sc.pl.dotplot,
      "pl_matrixplot": sc.pl.matrixplot,
      "pl_tracksplot": sc.pl.tracksplot,
      "pl_scatter": sc.pl.scatter,
      "embedding_density": sc.pl.embedding_density,
      "rank_genes_groups": sc.pl.rank_genes_groups,
      "pl_rank_genes_groups_dotplot": sc.pl.rank_genes_groups_dotplot,  # Add function mapping
      "pl_clustermap": sc.pl.clustermap,
      "pl_highly_variable_genes": sc.pl.highly_variable_genes,
      "pl_pca_variance_ratio": sc.pl.pca_variance_ratio,
  }

• src/scmcp/server.py:59-92 (registration)

  MCP server call_tool handler that dispatches pl_heatmap calls (via pl_tools check) to run_pl_func.

  @server.call_tool()
  async def call_tool(
      name: str, arguments
  ):
      try:
          logger.info(f"Running {name} with {arguments}")
          if name in io_tools.keys():            
              res = run_io_func(ads, name, arguments)
          elif name in pp_tools.keys():
              res = run_pp_func(ads, name, arguments)
          elif name in tl_tools.keys():
              res = run_tl_func(ads, name, arguments) 
          elif name in pl_tools.keys():
              res = run_pl_func(ads, name, arguments)
          elif name in util_tools.keys():            
              res = run_util_func(ads, name, arguments)
          elif name in ccc_tools.keys():            
              res = run_ccc_func(ads.adata_dic[ads.active], name, arguments)
          output = str(res) if res is not None else str(ads.adata_dic[ads.active])
          return [
              types.TextContent(
                  type="text",
                  text=str({"output": output})
              )
          ]
      except Exception as error:
          logger.error(f"{name} with {error}")
          return [
              types.TextContent(
                  type="text",
                  text=str({"Error": error})
              )
          ]