Skip to content

mcp-tools.mdx

Latest commit

 

History

History
220 lines (139 loc) · 5.44 KB

mcp-tools.mdx

File metadata and controls

220 lines (139 loc) · 5.44 KB
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?"
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.