@trigger.dev/sdk 4.5.0-rc.5 → 4.5.0-rc.7

package/docs/mcp-introduction.mdx

@@ -0,0 +1,385 @@
+---
+title: "MCP Introduction"
+sidebarTitle: "Introduction"
+description: "Learn how to install and configure the Trigger.dev MCP Server"
+---
+
+## What is the Trigger.dev MCP Server?
+
+The Trigger.dev MCP (Model Context Protocol) Server enables AI assistants to interact directly with your Trigger.dev projects. It provides a comprehensive set of tools to:
+
+- Search Trigger.dev documentation
+- Initialize new Trigger.dev projects
+- List and manage your projects and organizations
+- Get task information and trigger task runs
+- Deploy projects to different environments
+- Monitor run details and list runs with filtering options
+- Query your data with TRQL and run built-in dashboard metrics
+
+## Installation
+
+The quickest way to get set up is the interactive installer:
+
+```bash
+npx trigger.dev@latest install-mcp
+```
+
+It will detect your installed clients and configure them automatically. You can also copy-paste the config for your client below.
+
+## Client Configuration
+
+Each client has a slightly different config format. Copy the snippet for your client into the appropriate file.
+
+<Tabs>
+  <Tab title="Claude Code">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client claude-code
+    ```
+
+    Or add this configuration to `~/.claude.json` (user) or `.mcp.json` (project):
+
+    ```json
+    {
+      "mcpServers": {
+        "trigger": {
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    [View Claude Code MCP docs ↗](https://code.claude.com/docs/en/mcp)
+  </Tab>
+  <Tab title="Cursor">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client cursor
+    ```
+
+    Or add this configuration to `~/.cursor/mcp.json` (user) or `.cursor/mcp.json` (project):
+
+    ```json
+    {
+      "mcpServers": {
+        "trigger": {
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    [View Cursor MCP docs ↗](https://cursor.com/docs/context/mcp)
+  </Tab>
+  <Tab title="Windsurf">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client windsurf
+    ```
+
+    Or add this configuration to `~/.codeium/windsurf/mcp_config.json`:
+
+    ```json
+    {
+      "mcpServers": {
+        "trigger": {
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    [View Windsurf MCP docs ↗](https://docs.windsurf.com/windsurf/cascade/mcp)
+  </Tab>
+  <Tab title="VS Code">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client vscode
+    ```
+
+    Or add this configuration to `.vscode/mcp.json` (project) or `~/Library/Application Support/Code/User/mcp.json` (user, macOS):
+
+    ```json
+    {
+      "servers": {
+        "trigger": {
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    <Note>VS Code uses `servers` instead of `mcpServers`.</Note>
+
+    [View VS Code MCP docs ↗](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
+  </Tab>
+  <Tab title="Zed">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client zed
+    ```
+
+    Or add this configuration to `~/.config/zed/settings.json`:
+
+    ```json
+    {
+      "context_servers": {
+        "trigger": {
+          "source": "custom",
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    [View Zed context servers docs ↗](https://zed.dev/docs/ai/mcp)
+  </Tab>
+  <Tab title="Cline">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client cline
+    ```
+
+    Or add this configuration to `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`:
+
+    ```json
+    {
+      "mcpServers": {
+        "trigger": {
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    [View Cline MCP docs ↗](https://docs.cline.bot/mcp/configuring-mcp-servers)
+  </Tab>
+  <Tab title="Gemini CLI">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client gemini-cli
+    ```
+
+    Or add this configuration to `~/.gemini/settings.json` (user) or `.gemini/settings.json` (project):
+
+    ```json
+    {
+      "mcpServers": {
+        "trigger": {
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+  </Tab>
+  <Tab title="AMP">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client amp
+    ```
+
+    Or add this configuration to `~/.config/amp/settings.json`:
+
+    ```json
+    {
+      "amp.mcpServers": {
+        "trigger": {
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    [View Sourcegraph AMP MCP docs ↗](https://ampcode.com/manual#mcp)
+  </Tab>
+  <Tab title="Codex CLI">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client openai-codex
+    ```
+
+    Or add this configuration to `~/.codex/config.toml`:
+
+    ```toml
+    [mcp_servers.trigger]
+    command = "npx"
+    args = ["trigger.dev@latest", "mcp"]
+    startup_timeout_sec = 30
+    ```
+
+    <Note>The `startup_timeout_sec = 30` is recommended. Codex defaults to 10 seconds, which may not be enough for `npx` to download the package on first run.</Note>
+  </Tab>
+  <Tab title="Crush">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client crush
+    ```
+
+    Or add this configuration to `.crush.json` (project), `crush.json`, or `~/.config/crush/crush.json` (user). Files are loaded in priority order: `.crush.json` → `crush.json` → `$HOME/.config/crush/crush.json`.
+
+    ```json
+    {
+      "mcp": {
+        "trigger": {
+          "type": "stdio",
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+
+    [View Charm MCP docs ↗](https://github.com/charmbracelet/crush)
+  </Tab>
+  <Tab title="opencode">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client opencode
+    ```
+
+    Or add this configuration to `~/.config/opencode/opencode.json` (user) or `./opencode.json` (project):
+
+    ```json
+    {
+      "mcp": {
+        "trigger": {
+          "type": "local",
+          "command": ["npx", "trigger.dev@latest", "mcp"],
+          "enabled": true
+        }
+      }
+    }
+    ```
+
+    [View opencode MCP docs ↗](https://opencode.ai/docs/mcp-servers/)
+  </Tab>
+  <Tab title="Ruler">
+    Install using the command line:
+
+    ```bash
+    npx trigger.dev@latest install-mcp --client ruler
+    ```
+
+    Or add this configuration to `.ruler/mcp.json`:
+
+    ```json
+    {
+      "mcpServers": {
+        "trigger": {
+          "type": "stdio",
+          "command": "npx",
+          "args": ["trigger.dev@latest", "mcp"]
+        }
+      }
+    }
+    ```
+  </Tab>
+</Tabs>
+
+After adding the config, restart your client. You should see a server named **trigger** connect automatically.
+
+## Authentication
+
+The `search_docs` tool works without authentication. All other tools require you to be logged in via the [Trigger.dev CLI](/cli-login-commands). The first time you use an authenticated tool, your MCP client will prompt you to log in.
+
+<Accordion title="CLI Options">
+
+The `install-mcp` command supports these options:
+
+**Core Options**
+
+- `-p, --project-ref <project ref>` — Scope the MCP server to a specific project
+- `-t, --tag <package tag>` — CLI package version to use (default: latest)
+- `--dev-only` — Restrict to the dev environment only
+- `--readonly` — Read-only mode. Hides write tools (`deploy`, `trigger_task`, `cancel_run`) so the AI cannot make changes to your account
+- `--yolo` — Install into all supported clients automatically
+- `--scope <scope>` — `user`, `project`, or `local`
+- `--client <clients...>` — Install into specific client(s)
+
+**Configuration Options**
+
+- `--log-file <log file>` — Write logs to a file
+- `-a, --api-url <value>` — Custom Trigger.dev API URL
+- `-l, --log-level <level>` — Log level (debug, info, log, warn, error, none)
+
+**Examples**
+
+Install for all supported clients:
+
+```bash
+npx trigger.dev@latest install-mcp --yolo
+```
+
+Install for specific clients:
+
+```bash
+npx trigger.dev@latest install-mcp --client claude-code cursor --scope user
+```
+
+Restrict to dev environment for a specific project:
+
+```bash
+npx trigger.dev@latest install-mcp --dev-only --project-ref proj_abc123
+```
+
+Read-only mode (prevents AI from deploying or triggering tasks):
+
+```bash
+npx trigger.dev@latest install-mcp --readonly
+```
+
+To add these options to a manual config, append them to the `args` array:
+
+```json
+{
+  "args": ["trigger.dev@latest", "mcp", "--dev-only", "--project-ref", "proj_abc123"]
+}
+```
+
+</Accordion>
+
+## Getting Started
+
+Once installed, you can start using the MCP server by asking your AI assistant questions like:
+
+- `"Search the trigger docs for a ffmpeg example"`
+- `"Initialize trigger.dev in my project"`
+- `"Get all tasks in my project"`
+- `"Trigger my foobar task with a sample payload"`
+- `"Get the details of the latest run for my foobar task"`
+- `"List all runs for my foobar task"`
+- `"Deploy my project to staging"`
+- `"Deploy my project to production"`
+- `"How many runs failed in the last 7 days?"`
+- `"Show me the overview dashboard metrics"`
+- `"What tables can I query?"`
+
+## Next Steps
+
+<CardGroup cols={2}>
+  <Card title="MCP Tools" icon="wrench" href="/mcp-tools">
+    Explore all available MCP tools for managing your projects.
+  </Card>
+  <Card title="Skills" icon="wand-magic-sparkles" href="/skills">
+    Portable instruction sets that teach AI assistants Trigger.dev patterns.
+  </Card>
+</CardGroup>

package/docs/mcp-tools.mdx

@@ -0,0 +1,273 @@
+---
+title: "MCP Tools"
+sidebarTitle: "Tools"
+description: "Learn about how to use the tools available in the Trigger.dev MCP Server"
+---
+
+## Documentation and Search Tools
+
+### search_docs
+
+Search the Trigger.dev documentation for guides, examples, and API references.
+
+**Example usage:**
+- `"How do I create a scheduled task?"`
+- `"Show me webhook examples"`
+- `"What are the deployment options?"`
+
+## Project Management Tools
+
+### list_orgs
+
+List all organizations you have access to.
+
+**Example usage:**
+- `"What organizations do I have?"`
+- `"Show me my orgs"`
+
+### list_projects
+
+List all projects in your Trigger.dev account.
+
+**Example usage:**
+- `"What projects do I have?"`
+- `"List my Trigger.dev projects"`
+
+### create_project_in_org
+
+Create a new project in an organization.
+
+**Example usage:**
+- `"Create a new project called 'my-app'"`
+- `"Set up a new Trigger.dev project"`
+
+### initialize_project
+
+Initialize Trigger.dev in your project with automatic setup and configuration.
+
+**Example usage:**
+- `"Set up Trigger.dev in this project"`
+- `"Add Trigger.dev to my app"`
+
+## Task Management Tools
+
+### get_current_worker
+
+Get the current worker for a project, including the worker version, SDK version, and registered tasks with their payload schemas.
+
+**Example usage:**
+- `"What tasks are available?"`
+- `"Show me the tasks in dev"`
+
+### trigger_task
+
+Trigger a task to run with a specific payload. You can add a delay, set tags, configure retries, choose a machine size, set a TTL, or use an idempotency key.
+
+**Example usage:**
+- `"Run the email-notification task"`
+- `"Trigger my-task with userId 123"`
+- `"Execute the sync task in production"`
+
+## Run Monitoring Tools
+
+### get_run_details
+
+Get detailed information about a specific task run, including logs and status. Enable debug mode to get the full trace with all logs and spans.
+
+**Example usage:**
+- `"Show me details for run run_abc123"`
+- `"Why did this run fail?"`
+
+### list_runs
+
+List runs for a project. Filter by status, task, tags, version, machine size, or time period.
+
+**Example usage:**
+- `"Show me recent runs"`
+- `"List failed runs from the last 7 days"`
+- `"What runs are currently executing?"`
+
+### wait_for_run_to_complete
+
+Wait for a specific run to finish and return the result.
+
+**Example usage:**
+- `"Wait for run run_abc123 to complete"`
+
+### cancel_run
+
+Cancel a running or queued run.
+
+**Example usage:**
+- `"Cancel run run_abc123"`
+- `"Stop that task"`
+
+## Deployment Tools
+
+### deploy
+
+Deploy your project to staging or production.
+
+**Example usage:**
+- `"Deploy to production"`
+- `"Deploy to staging"`
+
+### list_deploys
+
+List deployments for a project. Filter by status or time period.
+
+**Example usage:**
+- `"Show me recent deployments"`
+- `"What's deployed to production?"`
+
+### list_preview_branches
+
+List all preview branches in the project.
+
+**Example usage:**
+- `"What preview branches exist?"`
+- `"Show me preview deployments"`
+
+## Profile Tools
+
+### whoami
+
+Show the current authenticated user, active CLI profile, email, and API URL.
+
+**Example usage:**
+- `"Who am I logged in as?"`
+- `"What profile am I using?"`
+
+### list_profiles
+
+List all configured CLI profiles and which one is currently active.
+
+**Example usage:**
+- `"What profiles do I have?"`
+- `"Show me my Trigger.dev profiles"`
+
+### switch_profile
+
+Switch the active CLI profile for this MCP session. This changes which Trigger.dev account and API URL are used for all subsequent tool calls.
+
+**Example usage:**
+- `"Switch to my production profile"`
+- `"Use the staging profile"`
+
+## Query and Analytics Tools
+
+### get_query_schema
+
+Get the schema for TRQL queries, including all available tables, their columns, data types, descriptions, and allowed values. Call this before using the query tool to understand what data is available.
+
+**Example usage:**
+- `"What tables and columns can I query?"`
+- `"Show me the query schema"`
+
+### query
+
+Execute a TRQL query against your Trigger.dev data. TRQL is a SQL-style query language for analyzing runs, metrics, and LLM usage.
+
+**Example usage:**
+- `"How many runs failed in the last 7 days?"`
+- `"Show me the top 10 most expensive tasks"`
+- `"Query the average execution duration by task"`
+
+### list_dashboards
+
+List available built-in dashboards with their widgets. Each dashboard contains pre-built queries for common metrics.
+
+**Example usage:**
+- `"What dashboards are available?"`
+- `"Show me the dashboard widgets"`
+
+### run_dashboard_query
+
+Execute a single widget query from a built-in dashboard. Use `list_dashboards` first to see available dashboards and widget IDs.
+
+**Example usage:**
+- `"Run the total runs widget from the overview dashboard"`
+- `"Show me the LLM cost over time from the AI dashboard"`
+
+## Dev Server Tools
+
+### start_dev_server
+
+Start the Trigger.dev dev server (`trigger dev`) in the background. Waits up to 30 seconds for the worker to be ready.
+
+**Example usage:**
+- `"Start the dev server"`
+- `"Run trigger dev"`
+
+### stop_dev_server
+
+Stop the running Trigger.dev dev server.
+
+**Example usage:**
+- `"Stop the dev server"`
+
+### dev_server_status
+
+Check the status of the dev server and view recent output. Shows whether it is stopped, starting, ready, or has errors.
+
+**Example usage:**
+- `"Is the dev server running?"`
+- `"Show me the dev server logs"`
+- `"Are there any build errors?"`
+
+<Callout type="warning">
+  The deploy and list_preview_branches tools are not available when the MCP server is running with the `--dev-only` flag. The `--readonly` flag hides deploy, trigger_task, and cancel_run.
+</Callout>
+
+## Agent Chat Tools
+
+These tools let you have conversations with [chat agents](/ai-chat/overview) directly from your AI coding tool. See the [Agent MCP guide](/ai-chat/mcp) for a walkthrough.
+
+### list_agents
+
+List all chat agents registered in the current worker. Agents are tasks created with `chat.agent()` or `chat.customAgent()`.
+
+**Example usage:**
+- `"What agents are available?"`
+- `"List my chat agents"`
+
+### start_agent_chat
+
+Start a conversation with a chat agent. Returns a chat ID for use with `send_agent_message`. Optionally preloads the agent so it initializes before the first message.
+
+**Parameters:**
+- `agentId` (required) — The agent task slug (e.g., `"support-agent"`)
+- `chatId` (optional) — A custom conversation ID. Auto-generated if omitted
+- `clientData` (optional) — Client data to include with every message (e.g., `{ userId: "user_123" }`). Must match the agent's `clientDataSchema` if one is defined
+- `preload` (optional, default: `true`) — Whether to preload the agent before the first message
+
+**Example usage:**
+- `"Start a chat with the support agent"`
+- `"Talk to the pr-review agent with userId abc"`
+
+### send_agent_message
+
+Send a message to an active agent chat and get the full response back. The agent remembers full context from previous messages in the same chat.
+
+**Parameters:**
+- `chatId` (required) — The chat ID from `start_agent_chat`
+- `message` (required) — The message text to send
+
+**Example usage:**
+- `"Tell the agent to review the latest PR"`
+- `"Ask it what tools it has available"`
+
+### close_agent_chat
+
+Close an agent chat conversation. The agent exits its loop gracefully. Without this, the agent will close on its own when its idle timeout expires.
+
+**Parameters:**
+- `chatId` (required) — The chat ID to close
+
+**Example usage:**
+- `"Close the chat"`
+- `"End the conversation"`
+
+<Callout type="warning">
+  The `start_agent_chat`, `send_agent_message`, and `close_agent_chat` tools are write operations and are not available in readonly mode.
+</Callout>