> ## Documentation Index
> Fetch the complete documentation index at: https://docs.exploratory.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Tools

The Desktop MCP lets an AI client work with the project open in Exploratory Desktop. Find what it can do by purpose.

## Scope

The table below shows the main tools as examples. There are many more; all of them are in All tools below. The tools below are the ones the Exploratory Desktop plugin guides the AI to use. Which tools you can use depends on your Desktop version and on the settings in System Settings > MCP / CLI: with Allow create, edit and delete off, only reading is possible.

| Purpose | What the AI can do | Tools (examples) |
| - | - | - |
| Data frames and wrangling | Read data frames, preview and profile them, add and remove wrangling steps, work with branches, run R code and save the result as a data frame. | create\_wrangling\_step, ai\_wrangle, preview\_data\_frame, profile\_data\_frame, create\_branch, execute\_r\_script, save\_result\_as\_dataframe |
| Data sources and connections | Read and save connections, import data, create and replace data sources, extract tables from PDF files. | get\_connections, save\_connection, create\_data\_source, replace\_data\_source, extract\_pdf\_tables |
| Charts | Create, change, copy and read charts (settings, data and image), export chart data. | create\_chart, update\_chart, get\_chart, get\_chart\_data, get\_chart\_image, copy\_chart, export\_chart\_data |
| Analytics | Create, change and read analytics (regression, tests, clustering and so on) and their templates. | create\_analytics, update\_analytics, get\_analytics, list\_analytics\_templates |
| Notes | Write, change, read, open, publish and export notes; ask the note AI. | create\_note, update\_note, get\_note, publish\_note, export\_note\_html, ask\_note\_ai |
| Dashboards | Create, change, validate, publish and export dashboards; set parameter values. | create\_dashboard, update\_dashboard, validate\_dashboard, publish\_dashboard, export\_dashboard\_pdf |
| Parameters | Create, rename, read and delete parameters. | save\_parameter, get\_parameters, rename\_parameter, delete\_parameter |
| System settings | Read and change system settings, color palettes, AI function templates and dictionaries. | get\_system\_settings, update\_system\_settings, save\_palette, save\_dictionary |

> **Some tools change and delete**
>
> Some of these tools delete things, publish and unpublish, or run R code. See [Permissions and settings](https://docs.exploratory.io/en/mcp/desktop/permissions.md) for how Desktop asks you first.

## All tools

There are 146 tools in all. 68 are always available, and 78 work only when Allow create, edit and delete is on in System Settings > MCP / CLI. The tools you can use depend on your Exploratory Desktop version and the MCP / CLI settings.

The always-available tools include reading and a few that only open a screen. With Allow create, edit and delete off, the other tools stop with a permission error.

### Projects (16)

**Always available (12)**

| Name | Available | What it does |
| - | - | - |
| ask\_project | Always | Asks which project to use before a write. |
| get\_environment | Always | Shows the connected Desktop: app version, Agent API version, OS, signed-in user and open projects. |
| get\_lineage | Always | Shows which data sources a chart, analytics, note or data frame is built on. |
| get\_project | Always | Reads one project's name, description, last update time and whether it is open. |
| get\_project\_history | Always | Reads and searches the project's change history. |
| list\_created\_artifacts | Always | Lists the charts, analytics, steps and branches the AI created or changed in this conversation. |
| list\_projects | Always | Lists the projects in this installation, newest first. |
| locate\_published\_source | Always | Traces published data back to where it came from. |
| open\_project | Always | Opens a local project in its window, or focuses the existing window. |
| search\_artifacts | Always | Searches the open project for items by name, comment or content. |
| search\_projects | Always | Searches all local projects for data frames, charts, analytics, notes and more. |
| search\_server\_projects | Always | Lists published projects on the signed-in Exploratory server. |

**Available with Allow create, edit and delete on (4)**

| Name | Available | What it does |
| - | - | - |
| close\_project | When Allow create, edit and delete is on | Closes the project's window after saving. |
| import\_project | When Allow create, edit and delete is on | Downloads a published project and imports it as a new local project. |
| restore\_project\_history | When Allow create, edit and delete is on | Restores the whole project to a point in its change history. |
| save\_project | When Allow create, edit and delete is on | Creates a new project, or imports a project file. |

### Data frames (10)

**Always available (6)**

| Name | Available | What it does |
| - | - | - |
| get\_data\_frame | Always | Reads a data frame's steps, column names, types and row count. |
| get\_step\_diagram | Always | Returns the Step Diagram of a data frame. |
| get\_summary\_view | Always | Returns the Summary table of a data frame. |
| list\_data\_frames | Always | Lists the data frames of the project. |
| preview\_data\_frame | Always | Returns the first rows of a data frame's last step. |
| profile\_data\_frame | Always | Summarizes every column: type, missing values, statistics and distribution. |

**Available with Allow create, edit and delete on (4)**

| Name | Available | What it does |
| - | - | - |
| execute\_r\_script | When Allow create, edit and delete is on | Runs an R script and returns the result. |
| manage\_data\_frame | When Allow create, edit and delete is on | Runs data frame and catalog actions such as rename and delete. |
| save\_result\_as\_dataframe | When Allow create, edit and delete is on | Saves the data of a chart or analytics output as a new data frame. |
| select\_data\_frame | When Allow create, edit and delete is on | Selects the data frame to work on and returns its columns. |

### Wrangling (15)

**Always available (2)**

| Name | Available | What it does |
| - | - | - |
| get\_wrangling\_command | Always | Shows the parameters a wrangling command accepts. |
| list\_ai\_proposals | Always | Lists the AI proposals of the project with their review status. |

**Available with Allow create, edit and delete on (13)**

| Name | Available | What it does |
| - | - | - |
| ai\_wrangle | When Allow create, edit and delete is on | Has the AI write an R script for a wrangling request and optionally add it as a step. |
| apply\_wrangling\_preview | When Allow create, edit and delete is on | Applies the changes tried by the preview in one commit. |
| copy\_wrangling\_steps | When Allow create, edit and delete is on | Copies steps into a data frame of this or another open project. |
| create\_branch | When Allow create, edit and delete is on | Creates a branch from a step. |
| create\_wrangling\_step | When Allow create, edit and delete is on | Adds one wrangling step to a data frame. |
| delete\_branch | When Allow create, edit and delete is on | Deletes a branch. |
| delete\_wrangling\_step | When Allow create, edit and delete is on | Deletes steps of a data frame. |
| edit\_wrangling\_steps | When Allow create, edit and delete is on | Edits existing steps the same way the step menus do. |
| move\_branch | When Allow create, edit and delete is on | Moves a branch to start from a different step. |
| preview\_wrangling\_steps | When Allow create, edit and delete is on | Tries changes on temporary objects and shows the effect without saving. |
| set\_step\_cache | When Allow create, edit and delete is on | Caches, refreshes or clears the data of a step. |
| set\_step\_disabled | When Allow create, edit and delete is on | Disables or re-enables a step without deleting it. |
| update\_ai\_proposal | When Allow create, edit and delete is on | Records whether a fix from an AI proposal worked after publishing. |

### Charts (15)

**Always available (7)**

| Name | Available | What it does |
| - | - | - |
| get\_chart | Always | Reads a chart's definition, data and parameters. |
| get\_chart\_data | Always | Runs a chart and returns the aggregated values. |
| get\_chart\_image | Always | Returns the chart as a PNG image. |
| get\_chart\_summary\_prompt | Always | Returns reference data with the actual values for writing a chart's AI Summary. |
| list\_chart\_maps | Always | Lists the maps available for map charts. |
| list\_chart\_settings | Always | Shows the settings and functions available for a chart type. |
| list\_charts | Always | Lists the charts of a data frame. |

**Available with Allow create, edit and delete on (8)**

| Name | Available | What it does |
| - | - | - |
| copy\_chart | When Allow create, edit and delete is on | Duplicates a chart, or pastes it into another data frame. |
| create\_chart | When Allow create, edit and delete is on | Creates an editable chart from a data frame. |
| delete\_chart | When Allow create, edit and delete is on | Deletes a chart. |
| export\_chart\_data | When Allow create, edit and delete is on | Writes a chart's data to a file. |
| install\_chart\_map | When Allow create, edit and delete is on | Installs or updates a map extension from the Exploratory server. |
| open\_chart | When Allow create, edit and delete is on | Opens a chart in the chart view. |
| save\_chart\_ai\_summary | When Allow create, edit and delete is on | Saves an interpretation as the chart's AI Summary. |
| update\_chart | When Allow create, edit and delete is on | Changes a chart's type, aggregation, name and other settings. |

### Analytics (9)

**Always available (5)**

| Name | Available | What it does |
| - | - | - |
| get\_analytics | Always | Reads an analytics result: type, settings and outputs. |
| get\_analytics\_summary\_prompt | Always | Returns reference data with the actual values for writing an analytics AI Summary. |
| get\_analytics\_template | Always | Shows the slots and settings an analytics type accepts. |
| list\_analytics | Always | Lists the analytics of a data frame. |
| list\_analytics\_templates | Always | Lists the analytics types that can be created. |

**Available with Allow create, edit and delete on (4)**

| Name | Available | What it does |
| - | - | - |
| create\_analytics | When Allow create, edit and delete is on | Creates and runs an analytics (regression, classification, clustering and so on). |
| delete\_analytics | When Allow create, edit and delete is on | Deletes an analytics. |
| save\_analytics\_ai\_summary | When Allow create, edit and delete is on | Appends an interpretation you wrote to the analytics' comment and saves it. |
| update\_analytics | When Allow create, edit and delete is on | Changes an analytics' columns, settings or type and runs it again. |

### Notes (10)

**Always available (3)**

| Name | Available | What it does |
| - | - | - |
| get\_note | Always | Reads one note including its Markdown body. |
| get\_note\_image | Always | Returns the whole note preview as a PNG image. |
| list\_notes | Always | Lists the notes of the project without their bodies. |

**Available with Allow create, edit and delete on (7)**

| Name | Available | What it does |
| - | - | - |
| ask\_note\_ai | When Allow create, edit and delete is on | Asks the note editor's AI to rewrite, translate or summarize note text. |
| create\_note | When Allow create, edit and delete is on | Creates a Markdown note that can embed charts and analytics. |
| delete\_note | When Allow create, edit and delete is on | Deletes a note. |
| export\_note\_html | When Allow create, edit and delete is on | Writes a note to an HTML file. |
| export\_note\_pdf | When Allow create, edit and delete is on | Writes a note to a PDF file. |
| open\_note | When Allow create, edit and delete is on | Opens a note in the window. |
| update\_note | When Allow create, edit and delete is on | Appends to or replaces the body of a note, or renames it. |

### Dashboards (9)

**Always available (4)**

| Name | Available | What it does |
| - | - | - |
| get\_dashboard | Always | Reads one dashboard's pages, Markdown, variables and settings. |
| get\_dashboard\_image | Always | Returns a page of a saved dashboard as a PNG image. |
| list\_dashboards | Always | Lists the dashboards of the project. |
| validate\_dashboard | Always | Checks a dashboard layout without saving it. |

**Available with Allow create, edit and delete on (5)**

| Name | Available | What it does |
| - | - | - |
| create\_dashboard | When Allow create, edit and delete is on | Creates a dashboard of pages, rows and panels. |
| delete\_dashboard | When Allow create, edit and delete is on | Deletes a dashboard. |
| export\_dashboard\_html | When Allow create, edit and delete is on | Writes a dashboard to an HTML file. |
| export\_dashboard\_pdf | When Allow create, edit and delete is on | Writes all pages of a dashboard to a PDF file. |
| update\_dashboard | When Allow create, edit and delete is on | Changes a dashboard's pages, panels, name and settings. |

### Data sources and connections (18)

**Always available (8)**

| Name | Available | What it does |
| - | - | - |
| get\_connections | Always | Reads the data connections, or one connection's items. |
| get\_data\_source\_params | Always | Shows the settings a data source plugin takes and whether it needs a connection. |
| identify\_data\_source | Always | Identifies the requested data source and returns its reference. |
| lookup\_connection | Always | Finds a selected connection and returns its metadata without credentials. |
| lookup\_reference | Always | Returns the AI Data reference for a kind of data source. |
| request\_connection\_creation | Always | Opens the connection creation dialog. |
| search\_schema | Always | Reads the saved table and column information of a connection. |
| validate\_connection | Always | Checks whether a saved connection has all required items. |

**Available with Allow create, edit and delete on (10)**

| Name | Available | What it does |
| - | - | - |
| create\_data\_source | When Allow create, edit and delete is on | Saves a data frame together with its data source. |
| delete\_connection | When Allow create, edit and delete is on | Deletes a data connection. |
| extract\_pdf\_tables | When Allow create, edit and delete is on | Checks the contents of a PDF table before importing it. |
| list\_pdf\_tables | When Allow create, edit and delete is on | Previews the tables found in a PDF file. |
| list\_schema\_nodes | When Allow create, edit and delete is on | Lists the child nodes of a path in a hierarchical connection. |
| read\_file\_header | When Allow create, edit and delete is on | Checks the beginning and format of a local text file. |
| replace\_data\_source | When Allow create, edit and delete is on | Replaces the data source of an existing data frame. |
| sample\_collections | When Allow create, edit and delete is on | Gets the actual table list and samples of a connection. |
| save\_connection | When Allow create, edit and delete is on | Opens the dialog to create or edit a connection; the user enters the values. |
| save\_schema\_info | When Allow create, edit and delete is on | Saves table and column information confirmed from a connection. |

### Parameters (6)

**Always available (2)**

| Name | Available | What it does |
| - | - | - |
| get\_parameters | Always | Reads the project's parameters. |
| get\_session\_parameters | Always | Reads the definitions of session parameters defined from the signed-in user's information. |

**Available with Allow create, edit and delete on (4)**

| Name | Available | What it does |
| - | - | - |
| delete\_parameter | When Allow create, edit and delete is on | Deletes a parameter. |
| rename\_parameter | When Allow create, edit and delete is on | Renames a parameter. |
| save\_parameter | When Allow create, edit and delete is on | Creates a parameter, or updates one that exists. |
| set\_dashboard\_parameter\_value | When Allow create, edit and delete is on | Changes the selected parameter values of a displayed dashboard. |

### Publishing (7)

**Always available (2)**

| Name | Available | What it does |
| - | - | - |
| list\_published | Always | Lists the notes, dashboards and data published from the project. |
| list\_teams | Always | Lists the teams you belong to. |

**Available with Allow create, edit and delete on (5)**

| Name | Available | What it does |
| - | - | - |
| publish\_dashboard | When Allow create, edit and delete is on | Publishes a dashboard to the server with a public URL. |
| publish\_data\_frame | When Allow create, edit and delete is on | Publishes a data frame's steps to the server. |
| publish\_note | When Allow create, edit and delete is on | Publishes a note to the server with a public URL. |
| publish\_project | When Allow create, edit and delete is on | Opens the Publish dialog for the project. |
| unpublish | When Allow create, edit and delete is on | Cancels the publishing of a note or dashboard. |

### Settings and shared resources (17)

**Always available (7)**

| Name | Available | What it does |
| - | - | - |
| get\_ai\_function\_presets | Always | Returns the preset instructions of the AI functions in the column menu. |
| get\_ai\_function\_templates | Always | Reads the saved AI function templates. |
| get\_dictionaries | Always | Reads the dictionaries used for text analysis. |
| get\_note\_prompt\_templates | Always | Reads the saved prompt templates for note editing. |
| get\_palettes | Always | Reads the color palettes you created. |
| get\_r\_packages | Always | Lists the custom R packages of the project. |
| get\_system\_settings | Always | Reads the system settings, with secrets hidden. |

**Available with Allow create, edit and delete on (10)**

| Name | Available | What it does |
| - | - | - |
| add\_r\_package | When Allow create, edit and delete is on | Installs an R package from CRAN or a local file. |
| delete\_ai\_function\_template | When Allow create, edit and delete is on | Deletes an AI function template. |
| delete\_note\_prompt\_template | When Allow create, edit and delete is on | Deletes a prompt template for note editing. |
| delete\_palette | When Allow create, edit and delete is on | Deletes a color palette. |
| delete\_r\_package | When Allow create, edit and delete is on | Removes a custom R package. |
| save\_ai\_function\_template | When Allow create, edit and delete is on | Saves an instruction as an AI function template. |
| save\_dictionary | When Allow create, edit and delete is on | Creates or updates a dictionary for text analysis. |
| save\_note\_prompt\_template | When Allow create, edit and delete is on | Saves a prompt template for note editing. |
| save\_palette | When Allow create, edit and delete is on | Creates or updates a color palette. |
| update\_system\_settings | When Allow create, edit and delete is on | Changes the system settings that are allowed to change. |

### Local data catalog (10)

**Always available (7)**

| Name | Available | What it does |
| - | - | - |
| fetch\_catalog\_item | Always | Reads one catalog item as Markdown: title, description, columns and more. |
| get\_catalog\_schedule | Always | Gets the refresh schedule of a catalog item. |
| get\_catalog\_schema | Always | Gets the columns of a catalog item with descriptions and statistics. |
| preview\_catalog\_data | Always | Gets rows of a catalog item, paged. |
| query\_catalog\_data | Always | Filters, groups, aggregates or joins catalog items. |
| read\_catalog | Always | Reads data frames, charts, analytics, notes, parameters and dashboards of the project in one call. |
| search\_catalog | Always | Searches the local data catalog on this computer. |

**Available with Allow create, edit and delete on (3)**

| Name | Available | What it does |
| - | - | - |
| delete\_catalog\_item | When Allow create, edit and delete is on | Deletes a catalog item with its data, schedule and access log. |
| set\_catalog\_schedule | When Allow create, edit and delete is on | Sets the refresh schedule of a catalog item. |
| update\_catalog\_item | When Allow create, edit and delete is on | Changes the description of a catalog item or its columns. |

### Other (4)

**Always available (3)**

| Name | Available | What it does |
| - | - | - |
| cancel\_execution | Always | Stops a long-running operation. |
| get\_execution | Always | Returns the progress and results of a long-running operation. |
| get\_guide | Always | Returns the usage guide of a tool. |

**Available with Allow create, edit and delete on (1)**

| Name | Available | What it does |
| - | - | - |
| rerun\_artifact | When Allow create, edit and delete is on | Re-runs a chart, analytics or other item of the open project. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.