MCP Server
Overview
Superset provides an MCP (Model Context Protocol) server that lets AI agents interact with your tasks, workspaces, and devices programmatically.
Capabilities
| Category | Tools |
|---|---|
| Tasks | Create, update, list, get, delete tasks |
| Workspaces | Create, update, switch, delete, list, navigate workspaces |
| Devices | List devices, projects, and app context |
| Organization | List members and task statuses |
| AI Sessions | Start autonomous AI agent sessions (Claude, Codex, Gemini, OpenCode, Pi, Copilot, Cursor Agent) and subagents |
Setup
CLI Options
claude mcp add superset --transport http https://api.superset.sh/api/agent/mcpcodex mcp add superset --url https://api.superset.sh/api/agent/mcpgemini mcp add --transport http superset https://api.superset.sh/api/agent/mcpRun opencode mcp add and follow the interactive prompts:
opencode mcp add
[2m┌[0m Add MCP server
[2m│[0m
[2m◇[0m Location
[2m│[0m [36mCurrent project[0m
[2m│[0m
[2m◇[0m Enter MCP server name
[2m│[0m [36msuperset[0m
[2m│[0m
[2m◇[0m Select MCP server type
[2m│[0m [36mRemote[0m
[2m│[0m
[2m◇[0m Enter MCP server URL
[2m│[0m [36mhttps://api.superset.sh/api/agent/mcp[0m
[2m│[0m
[2m◇[0m Does this server require OAuth authentication?
[2m│[0m [36mYes[0m
[2m│[0m
[2m◇[0m Do you have a pre-registered client ID?
[2m│[0m [36mNo[0m
[2m│[0m
[2m└[0m [32mMCP server added successfully[0mManual Configuration
Alternatively, you can manually configure the MCP server for each client:
Add a .mcp.json to your project root. Claude Code auto-discovers this file and handles OAuth authentication.
{
"mcpServers": {
"superset": {
"type": "http",
"url": "https://api.superset.sh/api/agent/mcp"
}
}
}Add to your claude_desktop_config.json:
{
"mcpServers": {
"superset": {
"type": "http",
"url": "https://api.superset.sh/api/agent/mcp"
}
}
}Add to .cursor/mcp.json in your project root:
{
"mcpServers": {
"superset": {
"url": "https://api.superset.sh/api/agent/mcp"
}
}
}Add to your ~/.codex/config.toml:
[mcp_servers.superset]
url = "https://api.superset.sh/api/agent/mcp"Add to your .gemini/settings.json:
{
"mcpServers": {
"superset": {
"httpUrl": "https://api.superset.sh/api/agent/mcp"
}
}
}Add to your opencode.json:
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"superset": {
"type": "remote",
"url": "https://api.superset.sh/api/agent/mcp"
}
}
}Authentication
The MCP server uses OAuth 2.1. When you first connect, you'll be prompted to authorize the connection in your browser. The token is scoped to your active organization.
API Key Authentication
For headless environments, CI/CD pipelines, or scripts where browser-based OAuth isn't practical, you can authenticate with an API key instead.
Generating an API key:
- Open the Superset desktop app
- Go to Settings > API Keys
- Click Create API Key
- Copy the key (it starts with
sk_live_)—you won't be able to see it again
Using the API key:
Pass the API key as a Bearer token in the Authorization header:
Authorization: Bearer sk_live_your_api_key_hereMCP clients that support custom headers can use this directly. For Claude Code, set the header in your .mcp.json:
{
"mcpServers": {
"superset": {
"type": "http",
"url": "https://api.superset.sh/api/agent/mcp",
"headers": {
"Authorization": "Bearer sk_live_your_api_key_here"
}
}
}
}API keys grant full access to your organization. Keep them secret and never commit them to version control. Use environment variables or secrets managers for CI/CD.
When to use which method:
| Method | Best for |
|---|---|
| OAuth 2.1 | Interactive use — Claude Desktop, Claude Code, Cursor |
| API Key | Headless/CI — scripts, automation, pipelines |
Available Tools
Task Management
| Tool | Description |
|---|---|
create_task | Create one or more tasks (batch up to 25) |
update_task | Update existing tasks |
list_tasks | List tasks with filters (status, assignee, priority, labels) |
get_task | Get a single task by ID or slug |
delete_task | Soft delete tasks |
list_task_statuses | List available status options |
Workspace Management
| Tool | Description |
|---|---|
create_workspace | Create a new git worktree workspace |
update_workspace | Update workspaces (rename) |
switch_workspace | Switch to a different workspace |
delete_workspace | Delete a workspace |
list_workspaces | List all workspaces on a device |
get_workspace_details | Get detailed information about a workspace on a device, including its tabs and panes. Use this to discover pane IDs. |
Device & Organization
| Tool | Description |
|---|---|
list_devices | List online devices in your organization |
list_projects | List all projects on a device |
get_app_context | Get current app state (active workspace, pathname) |
list_members | List organization members |
AI Sessions
| Tool | Description |
|---|---|
start_agent_session | Start an autonomous AI agent session for a task in an existing workspace. Requires taskId. Supports Claude, Codex, Gemini, OpenCode, Pi, Copilot, Cursor Agent, and Superset Chat (defaults to Claude). When paneId is provided, adds a new pane to the tab containing that pane instead of initializing a new tab. |
start_agent_session_with_prompt | Start an autonomous AI agent session in an existing workspace using a direct prompt instead of a task. Supports Claude, Codex, Gemini, OpenCode, Pi, Copilot, Cursor Agent, and Superset Chat (defaults to Claude). When paneId is provided, adds a new pane to the tab containing that pane instead of initializing a new tab. |
Chat Integration
In the built-in chat panel, use the /mcp slash command to see your workspace's configured MCP servers — their names, transport type (local/remote), and current state (enabled/disabled/invalid). This reads from your workspace MCP config (.mastracode/mcp.json or .mcp.json).
Example Usage
Once connected, you can ask your AI agent to:
- "Create a task for fixing the login bug"
- "List all my assigned tasks"
- "Create a new workspace for the auth feature"
- "Show me who's online in my team"
- "Start a Claude session on my MacBook to work on the auth task"
- "Start a Codex session in my auth workspace with the prompt 'fix the failing tests'"
- "Spin up a subagent to fix the failing tests"