add_raster_layer
Add raster data layers to QGIS projects for spatial analysis and visualization. Specify file paths and providers to integrate geospatial imagery into your GIS workflow.
Instructions
Add a raster layer to the project.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| provider | No | gdal | |
| name | No |
Implementation Reference
- Core QGIS handler that implements add_raster_layer by creating a QgsRasterLayer instance, validating it, adding it to the project, and returning layer metadata.def add_raster_layer(self, path, name=None, provider="gdal", **kwargs): """Add a raster layer to the project""" if not name: name = os.path.basename(path) # Create the layer layer = QgsRasterLayer(path, name, provider) if not layer.isValid(): raise Exception(f"Layer is not valid: {path}") # Add to project QgsProject.instance().addMapLayer(layer) return { "id": layer.id(), "name": layer.name(), "type": "raster", "width": layer.width(), "height": layer.height() }
- src/qgis_mcp/qgis_mcp_server.py:192-199 (handler)MCP tool definition and handler for 'add_raster_layer' that forwards parameters to the QGIS socket server via send_command.def add_raster_layer(ctx: Context, path: str, provider: str = "gdal", name: str = None) -> str: """Add a raster layer to the project.""" qgis = get_qgis_connection() params = {"path": path, "provider": provider} if name: params["name"] = name result = qgis.send_command("add_raster_layer", params) return json.dumps(result, indent=2)
- qgis_mcp_plugin/qgis_mcp_plugin.py:133-149 (registration)Registers all command handlers including 'add_raster_layer' in the handlers dictionary used by execute_command to dispatch socket commands.handlers = { "ping": self.ping, "get_qgis_info": self.get_qgis_info, "load_project": self.load_project, "get_project_info": self.get_project_info, "execute_code": self.execute_code, "add_vector_layer": self.add_vector_layer, "add_raster_layer": self.add_raster_layer, "get_layers": self.get_layers, "remove_layer": self.remove_layer, "zoom_to_layer": self.zoom_to_layer, "get_layer_features": self.get_layer_features, "execute_processing": self.execute_processing, "save_project": self.save_project, "render_map": self.render_map, "create_new_project": self.create_new_project, }