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

# Set Up Wherobots in Cursor

> Install the Wherobots VS Code Extension in Cursor and manually configure the MCP Server and Agent Skills for AI-assisted geospatial development.

<Badge color="purple">Public Preview</Badge>

[**Cursor**](https://cursor.com/product) by Anysphere is a Code OSS-based editor with built-in AI features.

The Wherobots extension installs from the Open VSX Registry, but the MCP Server and Agent Skills must be configured manually.

Cursor uses its own `mcp.json` schema (`mcpServers`, not `servers`), so follow the Cursor-specific steps below to install the MCP Server and Agent Skills.

## Component Overview

Wherobots' Agentic Tools consist of the following components that work together to provide our agentic experience:

<AccordionGroup>
  <Accordion title="MCP Server" icon="message-bot">
    Connects your AI assistant to Wherobots Cloud for catalog exploration, Spatial SQL generation, and query execution.
  </Accordion>

  <Accordion title="Agent Skills" icon="brain">
    Gives your AI assistant domain-specific Wherobots knowledge for more accurate commands and fewer errors.
  </Accordion>

  <Accordion title="Wherobots CLI" icon="terminal">
    Wraps the full Wherobots API into a single binary for job submission, log streaming, and automation.
  </Accordion>
</AccordionGroup>

## Why use Wherobots' agentic tools?

Wherobots' agentic tools connect your AI assistant to Wherobots Cloud and your local development environment so you can interact with your spatial data, catalogs, and jobs in a more intuitive way.

<AccordionGroup>
  <Accordion title="Explore your spatial catalog conversationally" icon="book-open">
    The MCP Server connects your AI assistant to Wherobots Cloud so you can browse catalogs, databases, and table schemas (including Overture Maps and your own datasets) by asking questions in plain language instead of navigating the console.
  </Accordion>

  <Accordion title="Generate Spatial SQL without memorizing functions" icon="code">
    Describe a geospatial task (e.g. "find buildings within 500m of this point") and the MCP Server returns optimized Spatial SQL using WherobotsDB's ST functions, spatial joins, and indexing patterns.
  </Accordion>

  <Accordion title="Submit and monitor Wherobots jobs from your editor" icon="rocket">
    Use the CLI or the extension to submit Spark job runs, stream logs in real time, check resource metrics, and cancel jobs without leaving your editor or terminal.
  </Accordion>

  <Accordion title="Get Wherobots-aware AI assistance" icon="brain">
    Agent Skills teach your AI assistant Wherobots-specific APIs, query patterns, and workflow sequences so it produces correct `wherobots` CLI commands, valid MCP tool calls, and accurate notebook code on the first try.
  </Accordion>
</AccordionGroup>

## Before you start

Prior to installing the Wherobots VS Code extension, make sure you have:

* [Cursor](https://www.cursor.com/) installed.
  * Active Cursor subscription in order to select the model used by your Agent within Cursor.
* A **Wherobots Account** within a Community, Professional, or Enterprise Organization. See [Create a Wherobots Account](/get-started/wherobots-cloud/create-account).

  <Info>
    **Organization Availability:** Available to all Wherobots Organization Editions.<br />

    * **Community Edition Organizations** can create and run local notebooks against the [Tiny and Micro runtimes](/develop/runtimes).
    * **Professional or Enterprise Organizations** are required for job submission, the Wherobots MCP server, and additional compute tiers. For more information, see [Upgrade Organization](/get-started/upgrade-organization) or [Organization Editions](/get-started/organization-management/organization-editions).
  </Info>
* [Node.js](https://nodejs.org/) installed (for running `npx skills` when installing Agent Skills).

## Install the extension

Run the following command in your terminal:

```bash theme={"system"}
cursor --install-extension Wherobots.wherobotsjobsubmit
```

Or install from the [Open VSX Registry](https://open-vsx.org/extension/Wherobots/wherobotsjobsubmit).

The Wherobots extension depends on the Jupyter extension from `ms-toolsai`. If Cursor prompts that it cannot activate the extension because of a missing Jupyter dependency, click **Install and Reload**.

<Frame caption="Cursor prompts to install the Jupyter dependency and reload the window after installing the Wherobots extension.">
  <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/install-reload-jupyter.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=afec0f928ff84449f15224b0d16f202c" alt="Cursor dialog prompting to install the Jupyter dependency and reload" width="2977" height="401" data-path="develop/agentic-tools/images/cursor/install-reload-jupyter.png" />
</Frame>

### Configure the extension

After installation, set your API key to connect to Wherobots Cloud.

<Tip>
  These steps apply to VS Code, Cursor, Windsurf, [Kiro](https://kiro.dev/), Positron, Antigravity, Trae, VS Codium, and other Code OSS editors. All use the same Command Palette and extension settings.
</Tip>

<Steps>
  <Step title="Open the Command Palette">
    To open the **Command Palette**, click the search bar at the top of your editor and type `>wherobots:`.

    <img src="https://mintcdn.com/wherobots/sQRlg2xOr4yRMlZ8/develop/vscode-extension/images/command-palette.png?fit=max&auto=format&n=sQRlg2xOr4yRMlZ8&q=85&s=2aa9ace9432dc208b27ea4ac2ca8730c" alt="Command Palette" width="1188" height="332" data-path="develop/vscode-extension/images/command-palette.png" />

    <Tip>
      You can also press <kbd>⌘</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Mac, <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows/Linux.
    </Tip>
  </Step>

  <Step title="Set your API key">
    1. If you don’t have an API key yet, click `Wherobots: Generate API Key on Wherobots Cloud` to create one.
    2. Click `Wherobots: Set API Key` and enter your existing or newly created [Wherobots API key](/get-started/wherobots-cloud/api-keys/) when prompted, then press <kbd>Enter</kbd>.

    <Note>
      API keys are stored securely in your editor's Secret Storage.
    </Note>
  </Step>
</Steps>

### Verify the installation

To confirm the extension is installed and configured correctly:

<Steps>
  <Step title="Open the Command Palette">
    To open the **Command Palette**, click the search bar at the top of your editor and type `>wherobots:`.

    <img src="https://mintcdn.com/wherobots/sQRlg2xOr4yRMlZ8/develop/vscode-extension/images/command-palette.png?fit=max&auto=format&n=sQRlg2xOr4yRMlZ8&q=85&s=2aa9ace9432dc208b27ea4ac2ca8730c" alt="Command Palette" width="1188" height="332" data-path="develop/vscode-extension/images/command-palette.png" />

    <Tip>
      You can also press <kbd>⌘</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Mac, <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows/Linux.
    </Tip>
  </Step>

  <Step title="Confirm available commands">
    Type **Wherobots** to see the available extension commands.
    At this point, you should see commands including:

    * `Wherobots: Set API Key`
    * `Wherobots: Create Workspace`
    * `Wherobots: Submit Job`
    * `Wherobots: Refresh Workspaces`
    * `Wherobots: Open Settings`
    * `Wherobots: Install Jupyter Extension`
  </Step>
</Steps>

### Apply the extension to all profiles (optional)

If you use multiple Cursor profiles, right-click the **Wherobots - Spatial AI Coding Assistant** entry in the Extensions view and select **Apply Extension to all Profiles** so the extension is available in every profile.

<Frame caption="Right-click the Wherobots extension in the Extensions view and select Apply Extension to all Profiles.">
  <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/apply-extension-all-profiles.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=9e0ffda0b73a79d5b11f148d50653b80" alt="Cursor extension context menu with Apply Extension to all Profiles highlighted" style={{ display: "block", margin: "0 auto", height: "400px", width: "auto" }} width="810" height="1631" data-path="develop/agentic-tools/images/cursor/apply-extension-all-profiles.png" />
</Frame>

## Configure the MCP Server

The [Wherobots MCP Server](/develop/mcp/mcp-server-setup) enables AI assistants to explore your spatial data catalogs, generate Spatial SQL, and execute queries. Cursor expects a project-level `.cursor/mcp.json` file with an `mcpServers` object.

<Steps>
  <Step title="Open Tools & MCPs in Cursor Settings">
    Open the **Command Palette** (<kbd>⌘</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on macOS, <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows/Linux), type **Cursor Settings: Tools & MCPs**, and press <kbd>Enter</kbd>.

    Under **Installed MCP Servers**, click **Add Custom MCP**. Cursor opens (or creates) `.cursor/mcp.json` in your project root.

    <Frame caption="Cursor Settings → Tools & MCPs with the Add Custom MCP button before any server is configured.">
      <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/cursor-settings-tools-mcps-empty.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=0fce46f5b80f2fb3cce51588b0d7cc71" alt="Cursor Settings Tools & MCPs empty state with Add Custom MCP button" width="2998" height="1262" data-path="develop/agentic-tools/images/cursor/cursor-settings-tools-mcps-empty.png" />
    </Frame>
  </Step>

  <Step title="Add the Wherobots MCP server">
    Paste the following into `.cursor/mcp.json`, replacing `<YOUR_WHEROBOTS_API_KEY>` with your [Wherobots API key](/get-started/wherobots-cloud/api-keys/), then save the file.

    ```json theme={"system"}
    {
      "mcpServers": {
        "wherobots-mcp-server": {
          "url": "https://api.cloud.wherobots.com/mcp/",
          "headers": {
            "x-api-key": "<YOUR_WHEROBOTS_API_KEY>"
          }
        }
      }
    }
    ```

    <Warning>
      Cursor requires the top-level key `mcpServers` (plural, camel-case) and **does not** accept the VS Code–style `servers` key or the `"type": "http"` field. If the file has either, Cursor will show *"Invalid config: mcpServers must be an object"* in Settings.
    </Warning>

    <Frame caption="Editing .cursor/mcp.json in Cursor. The file must be wrapped in an outer object and use mcpServers.">
      <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/mcp-json-file.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=64be6ecab4ef85c8cdf0feaa48c93c57" alt="Cursor editing .cursor/mcp.json" width="2045" height="1222" data-path="develop/agentic-tools/images/cursor/mcp-json-file.png" />
    </Frame>
  </Step>

  <Step title="Reload and confirm the server is enabled">
    1. Open the **Command Palette** and select **Developer: Reload Window**.
    2. Return to **Cursor Settings > Tools & MCPs** and confirm that `wherobots-mcp-server` is listed, has a green status dot, and lists its tools (for example, `list_catalogs_tool`, `list_tables_tool`, `describe_table_tool`, `execute_query_tool`, `search_documentation_tool`) plus prompts and a `get_version` resource.

    <Frame caption="wherobots-mcp-server listed in Cursor Settings with 8 tools, 3 prompts, and 1 resource enabled.">
      <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/verify-chat-result.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=d9051985a7bb2e4b55157c4efd884ac9" alt="wherobots-mcp-server enabled in Cursor Settings Tools & MCPs" width="2388" height="1477" data-path="develop/agentic-tools/images/cursor/verify-chat-result.png" />
    </Frame>
  </Step>
</Steps>

<Tip>
  The extension exposes optional settings for the MCP server — including query timeout, runtime size, and cloud region. See [Configure MCP server settings](/develop/mcp/mcp-server-setup#configure-mcp-server-settings).
</Tip>

## Install Agent Skills

[Agent Skills](/develop/agent-skills) give your AI assistant domain-specific knowledge about Wherobots workflows, APIs, and best practices. The Wherobots skill pack is distributed via the [skills CLI](https://skills.sh/).

<Steps>
  <Step title="Run the skills installer">
    From a terminal in your project root, run:

    ```bash theme={"system"}
    npx skills add -g wherobots/agent-skills
    ```

    The installer clones the Wherobots skills repository and launches an interactive wizard.
  </Step>

  <Step title="Select the Wherobots skills">
    When prompted with **Select skills to install**, press <kbd>Space</kbd> to toggle each skill and <kbd>Enter</kbd> to confirm. Select all three:

    * `wherobots-develop` — guidance for writing Wherobots jobs and using the SDK/CLI.
    * `wherobots-explore` — catalog discovery and spatial query generation via the MCP server.
    * `wherobots-usage` — interface decision matrix, auth setup, and scheduled-job patterns.

    <Frame caption="The skills installer prompts you to select which Wherobots skills to install.">
      <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/skills-select-skills.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=b6121642051ab70eff0994d9d249d05f" alt="skills CLI select skills prompt" width="1309" height="921" data-path="develop/agentic-tools/images/cursor/skills-select-skills.png" />
    </Frame>
  </Step>

  <Step title="Select Cursor as a target agent">
    On the **Which agents do you want to install to?** screen, make sure **Cursor** is selected under **Universal** (it is included by default). You can optionally add other agents from the **Additional agents** list (for example, Claude Code at `~/.claude/skills`).

    Press <kbd>Enter</kbd> to continue.

    <Frame caption="Choose which agents receive the skills. Cursor is included in the Universal list.">
      <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/skills-select-agents.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=c2e17f103862d3d3d6f0b1986b5196dc" alt="skills CLI agent selection prompt showing Cursor in the Universal list" width="1355" height="569" data-path="develop/agentic-tools/images/cursor/skills-select-agents.png" />
    </Frame>
  </Step>

  <Step title="Review and confirm installation">
    The installer prints an installation summary and security risk assessments (Gen, Socket, Snyk). When prompted **Proceed with installation?**, type `Yes` and press <kbd>Enter</kbd>.
  </Step>
</Steps>

## Verify your setup

1. Open a **New Agent** chat in Cursor (the chat panel on the right).

2. Confirm **Agent** is selected as the chat mode.

3. Ask a test question, for example:
   > List the available tables in wherobots\_pro\_data

4. If everything is configured, Cursor's agent calls `search_documentation_tool`, `list_catalogs_tool`, `list_databases_tool`, and `list_tables_tool` on `wherobots-mcp-server` and returns the catalogs, databases, and tables in your Organization.

   <Frame caption="Cursor's agent answering a catalog exploration question by calling tools on wherobots-mcp-server.">
     <img src="https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/cursor/verify-chat-result.png?fit=max&auto=format&n=1VPaQX-8_3pkVU6l&q=85&s=d9051985a7bb2e4b55157c4efd884ac9" alt="Cursor agent listing tables in wherobots_pro_data using MCP tools" width="2388" height="1477" data-path="develop/agentic-tools/images/cursor/verify-chat-result.png" />
   </Frame>

5. Re-open **Cursor Settings → Tools & MCPs** and confirm `wherobots-mcp-server` shows a green dot with all tools enabled.

## Pin the extension for easy access

If the Wherobots VS Code Extension is pinned to your sidebar, you can also create a new workspace by clicking the **Create Workspace** button.

<Frame caption="The Wherobots extension sidebar showing the Create Workspace button. Specific UI details vary by editor.">
  <img src="https://mintcdn.com/wherobots/sQRlg2xOr4yRMlZ8/develop/vscode-extension/images/create-workspace-button.png?fit=max&auto=format&n=sQRlg2xOr4yRMlZ8&q=85&s=e332886b053f117e25344181c1066f30" alt="Create Workspace button in the Wherobots sidebar" style={{ float: "none", marginLeft: "1rem", maxWidth: "300px" }} width="672" height="626" data-path="develop/vscode-extension/images/create-workspace-button.png" />
</Frame>

To pin the Wherobots extension to the sidebar:

<Steps>
  <Step title="Pin the extension">
    Right-click the **Activity Bar** (the vertical icon bar on the left side of your editor).

    A menu will appear showing all available extensions.
  </Step>

  <Step title="Select the extension">
    To pin the extension, find **Wherobots** in the list and click on it to ensure it's checked.

    <Frame caption="The Activity Bar context menu with the Wherobots extension checked. Specific UI details vary by editor.">
      <img src="https://mintcdn.com/wherobots/sQRlg2xOr4yRMlZ8/develop/vscode-extension/images/check-wherobots.png?fit=max&auto=format&n=sQRlg2xOr4yRMlZ8&q=85&s=e9b67e126c0b6eb539490848027b9514" alt="Wherobots extension checked in the Activity Bar" style={{ float: "none", marginLeft: "1rem", maxWidth: "300px" }} width="666" height="598" data-path="develop/vscode-extension/images/check-wherobots.png" />
    </Frame>

    Now you'll have easy access to the extension in your editor's sidebar.
  </Step>
</Steps>

## Troubleshooting

### `Invalid config: mcpServers must be an object` or `JSON syntax error`

Cursor validates `.cursor/mcp.json` against its own schema and will display these errors in **Cursor Settings → Tools & MCPs** when the file is malformed.

Common causes:

* Missing the outer `{ ... }` wrapper around the config — the JSON parser fails with *"End of file expected."*
* Using the VS Code key `"servers"` instead of Cursor's `"mcpServers"`.
* Including a `"type": "http"` field — Cursor does not use it.

Re-paste the snippet from [Configure the MCP Server](#configure-the-mcp-server) exactly as shown, save the file, and reload the window.

## Next steps

<CardGroup cols={2}>
  <Card title="Browse Your Data" icon="database" href="/develop/vscode-extension/integrate-your-data">
    Browse catalogs, schemas, and tables in the Data Hub sidebar.
  </Card>

  <Card title="AI-Assisted Notebooks" icon="notebook" href="/develop/vscode-extension/notebooks">
    Create and connect local notebooks to remote Wherobots compute.
  </Card>

  <Card title="Submit Job Runs" icon="play" href="/develop/vscode-extension/jobs">
    Submit Python scripts as Wherobots job runs from your editor.
  </Card>

  <Card title="MCP Server Best Practices" icon="message-bot" href="/develop/mcp/mcp-server-usage">
    Common tasks, example prompts, and cost considerations for the MCP Server.
  </Card>
</CardGroup>
