Skip to main content

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.

Public Preview Claude Code is a terminal-based agentic tool by Anthropic. Unlike the VS Code extension, Claude Code requires separate installation of the MCP Server, Agent Skills, and CLI.

​
Component Overview

Wherobots’ Agentic Tools consist of the following components that work together to provide our agentic experience:
Connects your AI assistant to Wherobots Cloud for catalog exploration, Spatial SQL generation, and query execution.
Gives your AI assistant domain-specific Wherobots knowledge for more accurate commands and fewer errors.
Wraps the full Wherobots API into a single binary for job submission, log streaming, and automation.

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

​
Before you start

The following prerequisites are required:
  • Claude Code installed.
  • A Wherobots Account within a Professional or Enterprise Organization. See Create a Wherobots Account.
  • A Wherobots API key.
    • You will need a Wherobots API key to use the Wherobots CLI with the MCP server and Claude Code.

​
Install and configure

1

Configure the MCP Server

  1. In a terminal, run the following command, replacing the placeholder with your preferred server name: 
    claude mcp add --transport http <YOUR_SERVER_NAME> https://api.cloud.wherobots.com/mcp/ --scope user
    The --scope user flag makes the server available to all your Claude Code agents. For more information on scope options, see the Claude Code documentation.
    When you first use the MCP server, a browser window opens for you to sign in to Wherobots and select your organization.
  2. Restart Claude Code after adding the server.
For more information on downloading, installing, and using Claude Code, see Claude Code overview and Quickstart in the Claude Code Documentation.
2

Install Agent Skills

Agent Skills give your AI assistant structured context about Wherobots workflows, APIs, and best practices.
npx skills add -g wherobots/agent-skills
3

Install the CLI (optional)

The Wherobots CLI wraps the full Wherobots API into a single binary for job submission, log streaming, and automation.
  1. Run the following commands to install the CLI: 
    gh repo clone wherobots/wbc-cli && cd wbc-cli && ./scripts/install-release.sh
  2. Set your API key: 
    export WHEROBOTS_API_KEY='<your-api-key>'
  3. Verify the connection: 
    wherobots api --tree

​
Verify installation

Ask a question in Claude Code: 
List the catalogs in my Wherobots Data Hub
If configured correctly, Claude Code will call the Wherobots MCP server (showing a tool such as list_catalogs) and return the catalogs available in your Organization.

​
Next steps

MCP Server Best Practices

Common tasks, example prompts, and cost considerations for the MCP Server.

MCP Server Demo Videos

Watch the MCP Server automate catalog discovery, spatial queries, and notebook generation.

Agent Skills

Learn more about available skills and installation options.

Agentic Terminal Usage

Use the CLI with Claude Code for natural language job management.

CLI Reference

Submit jobs, stream logs, and access the full Wherobots API.

MCP Server vs CLI

Understand when to use the MCP Server vs. the CLI.