Eric Allam
96243efe16
* Add MCP Server documentation to documentation site This change introduces comprehensive documentation for the Trigger.dev MCP Server, covering its installation, usage, and available tools. The addition is necessary to provide users with detailed guidance on leveraging the MCP Server for managing Trigger.dev projects, tasks, and deployment processes. - Updated `docs.json` to include a new section for the MCP Server documentation, improving navigation and accessibility. - Added `mcp-introduction.mdx` as an introductory guide to the MCP Server, detailing its purpose and installation steps. - Included `mcp-tools.mdx`, a document outlining each tool available in the MCP Server, complete with descriptions and example usages. - The new content is aimed at improving user understanding and efficiency in using Trigger.dev's MCP Server capabilities. * Refactor MCP installation documentation The changes were necessary to streamline the MCP installation guidance and align our documentation with the latest client support capabilities. Removing the manual installation section and redundant information helps reduce confusion for users. - Updated installation instructions to lead with auto-configuration for supported clients. - Cleaned up the options and examples sections to enhance clarity. - Reformatted client configuration details for better readability. - Removed outdated links in the "Next Steps" section, focusing on more direct resources such as available MCP tools. * mcp docs edits * Add debugMode to get_run_details * add cancel_run * Add list deployments tools * Add list preview branches tool * Docs: adds agent rules page * Adds redirect for the CLI path to work * Adds subagent install image --------- Co-authored-by: James Ritchie <james@trigger.dev>
119 lines
5.7 KiB
Plaintext
119 lines
5.7 KiB
Plaintext
---
|
|
title: "Agent rules"
|
|
sidebarTitle: "Agent rules"
|
|
description: "Learn how to use the Trigger.dev agent rules with the MCP server"
|
|
tag: "new"
|
|
---
|
|
|
|
## What are Trigger.dev agent rules?
|
|
|
|
Trigger.dev agent rules are comprehensive instruction sets that guide AI assistants to write optimal Trigger.dev code. These rules ensure your AI assistant understands best practices, current APIs, and recommended patterns when working with Trigger.dev projects.
|
|
|
|
## Installation
|
|
|
|
Install the agent rules with the following command:
|
|
|
|
```bash
|
|
npx trigger.dev@latest install-rules
|
|
```
|
|
|
|
## Available rule sets
|
|
|
|
We provide five specialized rule sets, each optimized for different aspects of Trigger.dev development:
|
|
|
|
| Rule set | Tokens | Description | GitHub |
|
|
|:---------|:-------|:------------|:------------|
|
|
| **Basic tasks** | 1,200 | Essential rules for writing basic Trigger.dev tasks and fundamental patterns | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/basic-tasks.md) |
|
|
| **Advanced tasks** | 3,000 | Comprehensive rules for complex workflows, error handling, and advanced task patterns | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/advanced-tasks.md) |
|
|
| **Scheduled tasks** | 780 | Specialized guidance for cron jobs, scheduled workflows, and time-based triggers | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/scheduled-tasks.md) |
|
|
| **Configuration** | 1,900 | Complete guide for trigger.config.ts setup, environment configuration, and project structure | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/config.md) |
|
|
| **Realtime** | 1,700 | Using Trigger.dev Realtime features and frontend integration patterns | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/realtime.md) |
|
|
|
|
## Claude Code subagent
|
|
|
|
For Claude Code users, we provide a subagent called `trigger-dev-expert` that's an expert at writing well-structured Trigger.dev code.
|
|
|
|
### Installation
|
|
|
|
The subagent is available as an option when running the rules installation command. Select "Claude Code" as your client and choose to include the subagent when prompted.
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
Activate the subagent in your prompts by requesting it explicitly:
|
|
|
|
```markdown
|
|
use the trigger-dev-expert subagent to create a trigger.dev job that accepts a video url, processes it with ffmpeg to extract the audio, runs the audio through a text-to-speech API like openai, and then uploads both the transcription and the audio to s3
|
|
```
|
|
|
|
The subagent works best when combined with the appropriate rule sets installed alongside it, providing both high-level architectural guidance and detailed implementation knowledge.
|
|
|
|
## Supported AI clients
|
|
|
|
The Trigger.dev rules work across a wide range of AI coding assistants and editors:
|
|
|
|
| Client | Rule activation | Docs |
|
|
|:--------|:----------------|:--------------|
|
|
| **Cursor** | Automatic when working in trigger directories | [Link](https://docs.cursor.com/en/context/rules#rules/) |
|
|
| **Claude Code** | Context-aware activation + custom subagent | [Link](https://docs.anthropic.com/en/docs/claude-code) |
|
|
| **VSCode Copilot** | Integration with GitHub Copilot chat | [Link](https://code.visualstudio.com/docs/copilot/overview) |
|
|
| **Windsurf** | Automatic activation in Trigger.dev projects | [Link](https://docs.windsurf.com/windsurf/cascade/memories#rules) |
|
|
| **Gemini CLI** | Command-line integration | [Link](https://ai.google.dev/gemini-api/docs) |
|
|
| **Cline** | Automatic context detection | [Link](https://github.com/cline/cline) |
|
|
| **Sourcegraph AMP** | Code intelligence integration | [Link](https://sourcegraph.com/docs) |
|
|
| **Kilo** | Custom rule integration | [Link](https://kilocode.ai/docs/advanced-usage/custom-rules) |
|
|
| **Ruler** | Rule management | [Link](https://github.com/intellectronica/ruler) |
|
|
| **AGENTS.md** | Universal format for OpenAI Codex, Jules, OpenCode, etc. | |
|
|
|
|
### Rule activation behavior
|
|
|
|
Different AI tools handle rules differently:
|
|
|
|
- **Automatic Activation**: Cursor, Windsurf, VSCode Copilot, and Cline automatically apply relevant rules when working in Trigger.dev projects or when `trigger.config.ts` is detected
|
|
- **Context-Aware**: Claude Code intelligently applies rules based on the current context and file types
|
|
- **Manual Integration**: AGENTS.md clients and others append rules to configuration files for manual activation
|
|
|
|
## Keeping rules updated
|
|
|
|
Trigger.dev rules are regularly updated to reflect new features, API changes, and best practices. The CLI includes automatic update detection.
|
|
|
|
### Automatic update notifications
|
|
|
|
When running `npx trigger.dev@latest dev`, you'll receive notifications when newer rule versions are available with a simple update command.
|
|
|
|
### Manual updates
|
|
|
|
Update rules anytime with:
|
|
|
|
```bash
|
|
npx trigger.dev@latest install-rules
|
|
```
|
|
|
|
The update process replaces existing rules without creating duplicates, keeping your configuration files clean and organized.
|
|
|
|
### Why updates matter
|
|
|
|
- **Current API patterns**: Access the latest Trigger.dev APIs and features
|
|
- **Performance optimizations**: Benefit from improved patterns and practices
|
|
- **Deprecated pattern avoidance**: Prevent AI assistants from generating outdated code
|
|
- **New feature support**: Immediate access to newly released capabilities
|
|
|
|
## Getting started
|
|
|
|
1. Install the rules:
|
|
|
|
```bash
|
|
npx trigger.dev@latest install-rules
|
|
```
|
|
|
|
2. Follow the prompts to install the rules for your AI client.
|
|
|
|
3. Consider installing the `trigger-dev-expert` subagent if using Claude Code.
|
|
|
|
## Next steps
|
|
|
|
- [Install the MCP server](/mcp-introduction) for complete Trigger.dev integration
|
|
- [Explore MCP tools](/mcp-tools) for project management and task execution
|
|
|