> ## 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 Your Editor

> Install the Wherobots VS Code Extension in VS Code, Cursor, Kiro, Windsurf, Positron, Antigravity, Trae, or VS Codium, and connect the MCP Server and Agent Skills.

Public Preview

The [Wherobots VS Code Extension](https://marketplace.visualstudio.com/items?itemName=wherobots.wherobotsjobsubmit) runs in VS Code and other Code OSS editors. In VS Code, it configures the [MCP Server](https://docs.wherobots.com/develop/mcp/mcp-server-overview.md) and includes [Agent Skills](https://docs.wherobots.com/develop/agent-skills.md) for you. In other editors, you install the extension the same way, then add the MCP Server and Agent Skills yourself once.

For what each Wherobots component does, see [What each component does](https://docs.wherobots.com/develop/agentic-tools.md#what-each-component-does). To use Wherobots from a terminal agent or a chat app instead, see [Set Up Wherobots in an AI Assistant](https://docs.wherobots.com/develop/agentic-tools/ai-assistants.md).

## Before you start

You need:

* A **Wherobots Account**. See [Create a Wherobots Account](https://docs.wherobots.com/get-started/wherobots-cloud/create-account.md).
  > [!NOTE]
  >
  > **Organization Availability:** Available to all Wherobots Organization Editions (Professional, Innovation, and Enterprise).
* One of the editors below, with an AI assistant for the AI-assisted features:

| Editor | Requirements |
| - | - |
| **VS Code** | [Visual Studio Code](https://code.visualstudio.com/) 1.93 or later, and an active [GitHub Copilot](https://github.com/features/copilot) subscription. |
| **Cursor** | [Cursor](https://www.cursor.com/), and [Node.js](https://nodejs.org/) with npm to install Agent Skills with `npx`. |
| **Kiro** | [Kiro](https://kiro.dev/). For plans, see [Kiro Pricing](https://kiro.dev/pricing/). |
| **Other Code OSS editors** | [Windsurf](https://windsurf.com/), [Positron](https://positron.posit.co/), [Antigravity](https://antigravity.google/), [Trae](https://www.trae.ai/), or [VS Codium](https://vscodium.com/); an AI assistant (in Windsurf, an active Windsurf AI subscription; in the others, an AI assistant extension); and [Node.js](https://nodejs.org/) with npm to install Agent Skills with `npx`. |

## Set up your editor

Choose your editor. Each tab covers installing the extension, signing in, connecting the MCP Server and Agent Skills, and opening your editor's agent chat.

**VS Code**

**1. Install the extension**

Run the following command in your terminal:

```bash theme={"system"}
code --install-extension wherobots.wherobotsjobsubmit
```

Or install from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=wherobots.wherobotsjobsubmit).

If VS Code prompts you to install a missing dependency extension (e.g., Jupyter), click **Install and Reload**.

**2. Sign in to Wherobots**

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) and run `Wherobots: Sign In`. A browser window opens for you to sign in to Wherobots and select your Organization; when you're done, return to your editor.

![Sign in through OAuth](https://mintcdn.com/wherobots/DMnWqML8c8j1wZKT/develop/vscode-extension/images/sign-in-oauth.png?fit=max\&auto=format\&n=DMnWqML8c8j1wZKT\&q=85\&s=c35c7d940895cdbc9766ba7bc4f0a5d1)

> [!NOTE]
>
> **Prefer an API key?** Run `Wherobots: Set API Key` and enter your existing or newly created [Wherobots API key](https://docs.wherobots.com/get-started/wherobots-cloud/api-keys.md) when prompted, then press <kbd>Enter</kbd>. If you don't have a key yet, run `Wherobots: Generate API Key on Wherobots Cloud` to create one first.

To confirm the extension is installed, type **Wherobots** in the Command Palette. You should see its commands, including `Wherobots: Create Workspace`, `Wherobots: Submit Job`, and `Wherobots: Open Settings`. To sign out at any time, run `Wherobots: Sign Out`.

**3. MCP Server and Agent Skills**

The extension configures the [Wherobots MCP Server](https://docs.wherobots.com/develop/mcp/mcp-server-overview.md) and includes [Agent Skills](https://docs.wherobots.com/develop/agent-skills.md) in VS Code. No manual setup is needed.

The extension also exposes optional settings for the MCP server, including query timeout, runtime size, and cloud region. See [Extension Settings](https://docs.wherobots.com/develop/vscode-extension/settings.md).

**4. Open the agent chat**

1. Open **GitHub Copilot Chat** via **View > Chat**.
2. Select **Agent** as the chat mode from the dropdown at the top of the chat panel.

   ![Screenshot showing the Agent mode dropdown](https://mintcdn.com/wherobots/sQRlg2xOr4yRMlZ8/develop/vscode-extension/images/agent-mode.png?fit=max\&auto=format\&n=sQRlg2xOr4yRMlZ8\&q=85\&s=f27cc427fa03df0fb0cf1111480fc64b)
3. Select an advanced model (Claude Opus, Claude Sonnet, GPT Codex, or Gemini Pro) for best results.

Then [verify your setup](#verify-your-setup).

**Cursor**

Cursor installs the extension from the Open VSX Registry, and you add the MCP Server and Agent Skills yourself. Cursor uses its own `mcp.json` schema (`mcpServers`, not `servers`).

**1. 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**.

![Cursor dialog prompting to install the Jupyter dependency and reload](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)

Cursor prompts to install the Jupyter dependency and reload the window after installing the Wherobots extension.

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.

![Cursor extension context menu with Apply Extension to all Profiles highlighted](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)

Right-click the Wherobots extension in the Extensions view and select Apply Extension to all Profiles.

**2. Sign in to Wherobots**

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) and run `Wherobots: Sign In`. A browser window opens for you to sign in to Wherobots and select your Organization; when you're done, return to your editor.

![Sign in through OAuth](https://mintcdn.com/wherobots/DMnWqML8c8j1wZKT/develop/vscode-extension/images/sign-in-oauth.png?fit=max\&auto=format\&n=DMnWqML8c8j1wZKT\&q=85\&s=c35c7d940895cdbc9766ba7bc4f0a5d1)

> [!NOTE]
>
> **Prefer an API key?** Run `Wherobots: Set API Key` and enter your existing or newly created [Wherobots API key](https://docs.wherobots.com/get-started/wherobots-cloud/api-keys.md) when prompted, then press <kbd>Enter</kbd>. If you don't have a key yet, run `Wherobots: Generate API Key on Wherobots Cloud` to create one first.

To confirm the extension is installed, type **Wherobots** in the Command Palette. You should see its commands, including `Wherobots: Create Workspace`, `Wherobots: Submit Job`, and `Wherobots: Open Settings`. To sign out at any time, run `Wherobots: Sign Out`.

**3. Add the MCP Server**

Cursor expects a project-level `.cursor/mcp.json` file with an `mcpServers` object.

1. Open the **Command Palette**, 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.

   ![Cursor Settings Tools & MCPs empty state with Add Custom MCP button](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)

   Cursor Settings → Tools & MCPs with the Add Custom MCP button before any server is configured.

2. Paste the following into `.cursor/mcp.json`, then save the file:

   ```json theme={"system"}
   {
     "mcpServers": {
       "wherobots-mcp-server": {
         "url": "https://api.cloud.wherobots.com/mcp/"
       }
     }
   }
   ```

   When you first use the MCP server, Cursor starts an OAuth flow: a browser window opens for you to sign in to Wherobots and select your organization.

   > [!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 shows *"Invalid config: mcpServers must be an object"* in Settings.

   ![Cursor editing .cursor/mcp.json](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)

   Editing .cursor/mcp.json in Cursor. The file must be wrapped in an outer object and use mcpServers.

3. Open the **Command Palette** and select **Developer: Reload Window**.

4. Return to **Cursor Settings > Tools & MCPs** and confirm that `wherobots-mcp-server` is listed, has a green status dot, and lists its 16 tools (for example, `list_catalogs_tool`, `list_tables_tool`, `describe_table_tool`, `submit_query_tool`, `get_query_status_tool`, `get_query_results_tool`, `search_documentation_tool`) plus prompts and a `get_version` resource. For the full list, see [Available tools](https://docs.wherobots.com/develop/mcp/mcp-server-overview.md#available-tools).

   ![wherobots-mcp-server enabled in Cursor Settings Tools & MCPs](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)

   wherobots-mcp-server listed in Cursor Settings with its tools, prompts, and resource enabled.

> **Alternative: Use an API key instead of OAuth**
>
> Add a `headers` object with your [Wherobots API key](https://docs.wherobots.com/get-started/wherobots-cloud/api-keys.md):
>
> ```json theme={"system"}
> {
>   "mcpServers": {
>     "wherobots-mcp-server": {
>       "url": "https://api.cloud.wherobots.com/mcp/",
>       "headers": {
>         "x-api-key": "<YOUR_WHEROBOTS_API_KEY>"
>       }
>     }
>   }
> }
> ```

**4. Install Agent Skills**

The Wherobots skill pack is distributed through the [skills CLI](https://skills.sh/).

1. 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.

2. 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`, `wherobots-explore`, and `wherobots-usage`.

   ![skills CLI select skills prompt](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)

   The skills installer prompts you to select which Wherobots skills to install.

3. 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.

   ![skills CLI agent selection prompt showing Cursor in the Universal list](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)

   Choose which agents receive the skills. Cursor is included in the Universal list.

4. 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>.

**5. Open the agent chat**

Open a **New Agent** chat in Cursor (the chat panel on the right) and confirm **Agent** is selected as the chat mode. Then [verify your setup](#verify-your-setup).

**Kiro**

Kiro installs the extension from the Open VSX Registry. You then enable MCP in Kiro's settings, add the MCP Server to an `mcp.json` file that uses Kiro's `mcpServers` schema, and import Agent Skills.

**1. Install the extension**

Run the following command in your terminal:

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

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

If Kiro prompts you to install a missing dependency extension (e.g., Jupyter), click **Install and Reload**.

> [!TIP]
>
> In Kiro, you can also open the **Command Palette** by clicking the search bar at the top of the editor and typing `>wherobots`.

**2. Sign in to Wherobots**

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) and run `Wherobots: Sign In`. A browser window opens for you to sign in to Wherobots and select your Organization; when you're done, return to your editor.

![Sign in through OAuth](https://mintcdn.com/wherobots/DMnWqML8c8j1wZKT/develop/vscode-extension/images/sign-in-oauth.png?fit=max\&auto=format\&n=DMnWqML8c8j1wZKT\&q=85\&s=c35c7d940895cdbc9766ba7bc4f0a5d1)

> [!NOTE]
>
> **Prefer an API key?** Run `Wherobots: Set API Key` and enter your existing or newly created [Wherobots API key](https://docs.wherobots.com/get-started/wherobots-cloud/api-keys.md) when prompted, then press <kbd>Enter</kbd>. If you don't have a key yet, run `Wherobots: Generate API Key on Wherobots Cloud` to create one first.

To confirm the extension is installed, type **Wherobots** in the Command Palette. You should see its commands, including `Wherobots: Create Workspace`, `Wherobots: Submit Job`, and `Wherobots: Open Settings`. To sign out at any time, run `Wherobots: Sign Out`.

**3. Enable MCP support**

Kiro connects to MCP servers only after MCP is enabled.

1. Press <kbd>⌘</kbd> + <kbd>,</kbd> on macOS or <kbd>Ctrl</kbd> + <kbd>,</kbd> on Windows/Linux to open **Settings**, and make sure the following are enabled:

   * `wherobotsjobsubmit.mcpServerEnabled`
   * `kiroAgent.configureMCP`

   ![Kiro Settings panel with the Wherobots MCP server and job submission settings enabled](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-enabled-mcp-and-job.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=c1f3cddf2f4648bbf836370e9a78e401)

   Kiro Settings showing `wherobotsjobsubmit.mcpServerEnabled` and `kiroAgent.configureMCP` both turned on.

2. In Kiro's **Command Palette**, search for `kiro: open MCP Config`.

   ![Kiro Settings with MCP enabled dropdown](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-mcp-config.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=6d196f276eee39071973a0de22de0b9a)

**4. Add the MCP Server**

Kiro stores MCP configuration in `mcp.json` using a `mcpServers` object, at one of two levels:

| Config level | File path & When to use |
| - | - |
| **User Config** | `~/.kiro/settings/mcp.json` — Applies to every Kiro workspace; use when you want the Wherobots MCP server available globally. |
| **Workspace Config** | `.kiro/settings/mcp.json` (project root) — Applies only to the current workspace; use when projects need different API keys or server configurations. |

These steps use the **User Config**. To use the Workspace Config instead, create `.kiro/settings/mcp.json` in your project root with the same content.

1. In the same MCP Settings view, click **Open User MCP Config (JSON)**, or run **Kiro: Open User MCP Config (JSON)** from the **Command Palette**. Kiro opens `~/.kiro/settings/mcp.json`.

   ![Kiro MCP config editor showing User Config and Workspace Config tabs](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-mcp-json-workspace-user.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=b2a9e97a457751f15e43c09dfc759658)

   Choose between the User Config and Workspace Config tabs in the Kiro MCP config editor.

2. Paste the following into `mcp.json`, replacing `YOUR_WHEROBOTS_API_KEY` with your [Wherobots API key](https://docs.wherobots.com/get-started/wherobots-cloud/api-keys.md). If the file already contains other servers, add the new entry alongside them.

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

   > [!WARNING]
   >
   > Kiro requires the top-level key `mcpServers` and **does not** accept the VS Code-style `servers` key or the `"type": "http"` field. Using either produces an *"Error loading powers config: Unexpected token"* message in the Output panel.

3. Save the file. Kiro detects the change and may add `disabled`, `autoApprove`, and `disabledTools` fields to the entry.

4. Open the **Output** panel (<kbd>⌘</kbd> + <kbd>Shift</kbd> + <kbd>U</kbd>) and look for the following message in the **Kiro - MCP Logs** output stream:

   ```sh wrap theme={"system"}
   [info] [wherobots-mcp-server] Successfully connected and synced tools and resources for MCP server
   ```

   If you see this message, the server is connected and ready to use.

**5. Import Agent Skills**

Kiro imports skills directly from GitHub through the **Agent Steering & Skills** panel in the sidebar. Install all three Wherobots skills: `wherobots-develop`, `wherobots-explore`, and `wherobots-usage`.

1. Click the ![Kiro logo](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-icon.svg?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=ec7fa74cc69acab1240488f9a5f7ac7c) Kiro icon in the Activity Bar, open the **AGENT STEERING & SKILLS** section, and click **+** to add a new skill.

   ![Kiro Agent Steering & Skills section with + button to add a new skill highlighted](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-point-plus-skills.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=c11bf5fc0d006d6cebb3cccd683e2caa)

2. Type **Agent Skills** in the search bar that appears, and select either **Global agent skills** or Project-specific agent skills from the dropdown.

   ![Kiro Agent Steering & Skills section with search bar for Agent Skills highlighted](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-agent-skills-global.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=9fc561f469b88f2ebd4f151e07b02fc7)

3. Click **Import skill from GitHub**. A dialog opens where you can paste the URL of the skill's GitHub repository.

   ![Kiro import skill dialog with Import skill from GitHub option highlighted](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-import-skill-method.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=12955c70ec46df870969d4bd9e479741)

   ![Kiro dialog prompting for a GitHub repository URL to import a skill](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-enter-gh-url.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=a339ee4671d60f00331777410b6c414a)

4. For each URL below, copy the URL, paste it into Kiro's import dialog, and press <kbd>Enter</kbd>:

   ```sh wrap theme={"system"}
   https://github.com/wherobots/agent-skills/tree/main/.agents/skills/wherobots-develop
   ```

   ```sh wrap theme={"system"}
   https://github.com/wherobots/agent-skills/tree/main/.agents/skills/wherobots-explore
   ```

   ```sh wrap theme={"system"}
   https://github.com/wherobots/agent-skills/tree/main/.agents/skills/wherobots-usage
   ```

   After each import, Kiro downloads the `SKILL.md` file and adds the skill to the **AGENT STEERING & SKILLS** section.

5. Confirm that all three skills appear under **AGENT STEERING & SKILLS** in the sidebar.

   ![Kiro sidebar with all three Wherobots skills installed under Agent Steering & Skills](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-agent-steering-skills.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=67234152e584c50e6ee78ea62b2c5cf7)

   The Kiro sidebar showing wherobots-develop, wherobots-explore, and wherobots-usage installed under Agent Steering & Skills.

**6. Open the agent chat**

1. Check the **MCP SERVERS** section in Kiro's sidebar. You should see `wherobots` with **Connected (16 tools)** and a list of tools including `list_catalogs_tool`, `list_tables_tool`, and `search_documentation_tool`. For the full list, see [Available tools](https://docs.wherobots.com/develop/mcp/mcp-server-overview.md#available-tools).

   ![Kiro sidebar showing the wherobots MCP server connected](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/kiro-mcp-servers-activity-bar.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=39c51d0df710f2d6487600b9a205679c)

   The MCP SERVERS section in Kiro's sidebar showing the wherobots MCP server connected.

2. Open a **New Session** chat panel. When the agent calls a Wherobots tool, you may be prompted to **Trust** or **Run** the tool call.

   ![Kiro chat calling list\_catalogs\_tool via MCP](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/verify-chat-tool-call-list.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=128e59a4dcfeaab2fa69178dfd82693a)

   Kiro's agent calling list\_catalogs\_tool to list available Wherobots catalogs.

Then [verify your setup](#verify-your-setup).

**Other Code OSS editors**

The extension installs from the Open VSX Registry in each of these editors, and you add the MCP Server and Agent Skills yourself. Installing the extension and Agent Skills works the same way in every editor; where you add the MCP Server differs by editor.

| Editor | Description | CLI command |
| - | - | - |
| [Windsurf](https://windsurf.com/) | Code OSS-based editor by Cognition AI with AI-powered development features | `windsurf` |
| [Positron](https://positron.posit.co/) | Code OSS-based editor by Posit designed for data science workflows | `positron` |
| [Antigravity](https://antigravity.google/) | Code OSS-based editor by Google | `antigravity` |
| [Trae](https://www.trae.ai/) | Code OSS-based editor by ByteDance with AI-powered development features | `trae` |
| [VS Codium](https://vscodium.com/) | Community-driven, freely-licensed distribution of VS Code | `codium` |

Using a Code OSS editor not listed here? Follow these steps and substitute your editor's CLI command.

> [!NOTE]
>
> These instructions are a preliminary adaptation of the standard VS Code Extension within the Windsurf, Positron, Antigravity, Trae, or VS Codium environment. Users may encounter steps that require manual adjustment. Should you experience any technical difficulties, please [contact Wherobots Support](https://docs.wherobots.com/support.md) for assistance.

**1. Install the extension**

Run the command for your editor in your terminal:

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

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

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

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

```bash VS Codium theme={"system"}
codium --install-extension Wherobots.wherobotsjobsubmit
```

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

If your editor prompts you to install a missing dependency extension (e.g., Jupyter), click **Install and Reload**.

**2. Sign in to Wherobots**

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) and run `Wherobots: Sign In`. A browser window opens for you to sign in to Wherobots and select your Organization; when you're done, return to your editor.

![Sign in through OAuth](https://mintcdn.com/wherobots/DMnWqML8c8j1wZKT/develop/vscode-extension/images/sign-in-oauth.png?fit=max\&auto=format\&n=DMnWqML8c8j1wZKT\&q=85\&s=c35c7d940895cdbc9766ba7bc4f0a5d1)

> [!NOTE]
>
> **Prefer an API key?** Run `Wherobots: Set API Key` and enter your existing or newly created [Wherobots API key](https://docs.wherobots.com/get-started/wherobots-cloud/api-keys.md) when prompted, then press <kbd>Enter</kbd>. If you don't have a key yet, run `Wherobots: Generate API Key on Wherobots Cloud` to create one first.

To confirm the extension is installed, type **Wherobots** in the Command Palette. You should see its commands, including `Wherobots: Create Workspace`, `Wherobots: Submit Job`, and `Wherobots: Open Settings`. To sign out at any time, run `Wherobots: Sign Out`.

**3. Add the MCP Server**

Each editor needs the same two values: the server URL, `https://api.cloud.wherobots.com/mcp/`, and an `x-api-key` header with your [Wherobots API key](https://docs.wherobots.com/get-started/wherobots-cloud/api-keys.md). Where you add them depends on the editor:

| Editor | Where to add the MCP Server |
| - | - |
| Positron | The **MCP: Add Server** command, as described below. See [Posit's Positron example](https://docs.posit.co/rspm/admin/ai/mcp.html). |
| VS Codium | The **MCP: Add Server** command, if your build has it, as described below. Otherwise, the MCP settings of your AI assistant extension. |
| Windsurf | `mcp_config.json`, which you open from the Cascade panel: the **...** menu, then **Open MCP config file** in the MCPs section. See the [Windsurf MCP documentation](https://docs.devin.ai/desktop/cascade/mcp). |
| Antigravity | `mcp_config.json`, which you open from the agent panel: **...** > **MCP Servers** > **Manage MCP Servers** > **View raw config**. See the [Antigravity MCP documentation](https://antigravity.google/docs/mcp). |
| Trae | Trae's MCP settings. See the [Trae MCP documentation](https://docs.trae.ai/ide/model-context-protocol). |

**Positron and VS Codium:**

1. Open the **Command Palette**, type **MCP: Add Server**, and select it.

2. Select **HTTP (HTTP or Server-Sent Events)** as the server type.

3. Enter the URL `https://api.cloud.wherobots.com/mcp/` and a name for the server (e.g., `wherobots-mcp-server`).

4. Your `mcp.json` file opens. Add a `headers` object with your Wherobots API key, then save the file:

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

5. Open the **Command Palette** and select **Reload Window**.

**Windsurf and Antigravity:** `mcp_config.json` uses an `mcpServers` object and a `serverUrl` field instead of the `servers` object and `url` field of VS Code's `mcp.json`. Add the Wherobots server inside the existing `mcpServers` object if the file already lists other servers, then save the file:

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

**4. Install Agent Skills**

Run the following command in your terminal:

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

**5. Open the agent chat**

1. Confirm the server appears in the editor's list of MCP servers. In Positron and VS Codium, open the **Command Palette** and run **MCP: List Servers**. In Windsurf, check the MCPs section of the Cascade panel's **...** menu. In Antigravity, open **Manage MCP Servers**.
2. Open your AI assistant's chat panel (Cascade in Windsurf) and select **Agent** as the chat mode, if available.

Then [verify your setup](#verify-your-setup).

## Verify your setup

In your editor's agent chat, ask a test question:

```text wrap theme={"system"}
List the catalogs in my Wherobots Organization
```

If everything is configured, the assistant calls a Wherobots MCP tool such as `list_catalogs_tool` and returns the catalogs available in your Organization, including `wherobots_open_data`, `wherobots_pro_data`, and any private catalogs.

![Screenshot showing the MCP server catalogs response](https://mintcdn.com/wherobots/IMHna5Z6Z-9kG6n0/develop/mcp/mcp-images/chat-response-catalogs.png?fit=max\&auto=format\&n=IMHna5Z6Z-9kG6n0\&q=85\&s=b8d180f349561a9d3c81b3f660a68abd)

## 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.

![Create Workspace button in the Wherobots sidebar](https://mintcdn.com/wherobots/sQRlg2xOr4yRMlZ8/develop/vscode-extension/images/create-workspace-button.png?fit=max\&auto=format\&n=sQRlg2xOr4yRMlZ8\&q=85\&s=e332886b053f117e25344181c1066f30)

The Wherobots extension sidebar showing the Create Workspace button. Specific UI details vary by editor.

To pin the Wherobots extension to the sidebar:

**1. 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.

**2. Select the extension**

To pin the extension, find **Wherobots** in the list and click on it to ensure it's checked.

![Wherobots extension checked in the Activity Bar](https://mintcdn.com/wherobots/sQRlg2xOr4yRMlZ8/develop/vscode-extension/images/check-wherobots.png?fit=max\&auto=format\&n=sQRlg2xOr4yRMlZ8\&q=85\&s=e9b67e126c0b6eb539490848027b9514)

The Activity Bar context menu with the Wherobots extension checked. Specific UI details vary by editor.

Now you'll have easy access to the extension in your editor's sidebar.

## Troubleshooting

> **Cursor: Invalid config: mcpServers must be an object, or JSON syntax error**
>
> Cursor validates `.cursor/mcp.json` against its own schema and displays 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, which Cursor does not use.
>
> Re-paste the snippet from the [Cursor](#cursor) steps exactly as shown, save the file, and reload the window.

> **Kiro: MCP: Browse MCP Servers results in an error**
>
> Kiro does not implement the VS Code `workbench.mcp.browseServers` command. Running **MCP: Browse MCP Servers** from the Command Palette displays *"command 'workbench.mcp.browseServers' not found"*. This does **not** mean the MCP server is broken.
>
> ![Kiro error dialog showing the workbench.mcp.browseServers command not found](https://mintcdn.com/wherobots/1VPaQX-8_3pkVU6l/develop/agentic-tools/images/kiro/browse-mcp-error.png?fit=max\&auto=format\&n=1VPaQX-8_3pkVU6l\&q=85\&s=fcc28b2e29da59a50ff66c7b2c9decd8)
>
> Kiro error dialog: 'command workbench.mcp.browseServers not found' after running MCP: Browse MCP Servers.
>
> To verify the server is working, check the **MCP SERVERS** section in Kiro's sidebar for a green **Connected** status, check **Output** → **Kiro - MCP Logs** for the "Successfully connected" message, or ask the test question in chat.

> **Kiro: Error loading powers config: Unexpected token**
>
> This error appears in the Output panel and as a notification when `mcp.json` contains invalid JSON or uses the wrong schema. Common causes:
>
> * Using the VS Code key `"servers"` instead of Kiro's `"mcpServers"`.
> * Including a `"type": "http"` field, which Kiro does not use.
> * Missing the outer `{ ... }` wrapper, or a trailing comma.
>
> Re-paste the snippet from the [Kiro](#kiro) steps exactly as shown, save the file, and check the Output panel for a successful connection.

> **Kiro: MCP is currently disabled**
>
> If you see a banner saying *"MCP is currently disabled. To start using MCP, please enable it in the settings."*, follow the **Enable MCP support** step in the [Kiro](#kiro) tab to turn on MCP in Kiro's settings.

## Next steps

> **[Browse Your Data](https://docs.wherobots.com/develop/vscode-extension/integrate-your-data.md)**
>
> Browse catalogs, schemas, and tables in the Data Hub sidebar.

> **[AI-Assisted Notebooks](https://docs.wherobots.com/develop/vscode-extension/notebooks.md)**
>
> Create and connect local notebooks to remote Wherobots compute.

> **[Submit Job Runs](https://docs.wherobots.com/develop/vscode-extension/jobs.md)**
>
> Submit Python scripts as Wherobots job runs from your editor.

> **[Workspaces & Usage](https://docs.wherobots.com/develop/vscode-extension/workspaces.md)**
>
> Create, start, stop, and manage notebook workspaces.

> **[MCP Server Best Practices](https://docs.wherobots.com/develop/mcp/mcp-server-usage.md)**
>
> Common tasks, example prompts, and cost considerations for the MCP Server.

> **[Install the CLI](https://docs.wherobots.com/develop/cli.md)**
>
> Submit jobs and access the full Wherobots API from your terminal.


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