AI tools¶
Experimental Feature
Tools are currently experimental and under active development. Tool definitions and availability may change.
marimo exposes a set of tools that allow AI assistants to interact with your notebooks. These tools enable AI agents to read notebook content, inspect cell runtime data, access variables, handle errors, and more.
Using tools¶
These tools are available when using the chat panel in ask mode. External AI applications can also access these tools through the marimo MCP server.
Available tools¶
Inspection¶
Tool | Description |
---|---|
get_active_notebooks | List all currently active marimo notebooks. Returns summary statistics and notebook details including names, paths, and session IDs. Start here to discover which notebooks are available. |
get_lightweight_cell_map | Get an overview of notebook structure showing a preview of each cell. Takes a session_id and optional preview_lines parameter. Returns cell IDs, preview text, line counts, and cell types (code, markdown, SQL). |
get_cell_runtime_data | Get detailed runtime information for a specific cell. Takes session_id and cell_id parameters. Returns full cell code, error details, runtime metadata (execution time, runtime state), and variables defined by the cell. |
Data¶
Tool | Description |
---|---|
get_tables_and_variables | Get information about variables and data tables in a session. Takes session_id and variable_names parameters (empty list returns all). Returns table metadata (columns, primary keys, indexes, row counts) and variable values with data types. |
get_database_tables | Get database schema information with optional query filtering. Takes session_id and optional query parameter (supports regex). Returns tables with connection name, database, schema, and table details. |
Debugging¶
Tool | Description |
---|---|
get_notebook_errors | Get all errors in the notebook organized by cell. Takes session_id parameter. Returns error summary (total errors, affected cells) and per-cell error details (type, message, traceback). |
Reference¶
Tool | Description |
---|---|
get_marimo_rules | Get official marimo guidelines and best practices for AI assistants. Returns the content of the marimo rules file and source URL for understanding marimo-specific conventions. |
Related documentation¶
- Model Context Protocol (MCP) - Learn how to expose tools through the marimo MCP server
- AI-assisted coding - Learn about more AI coding features