Skip to content

Commit 2ab54e6

Browse files
committed
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.
1 parent 132008f commit 2ab54e6

File tree

3 files changed

+531
-0
lines changed

3 files changed

+531
-0
lines changed

docs/docs.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,13 @@
179179
}
180180
]
181181
},
182+
{
183+
"group": "MCP Server",
184+
"pages": [
185+
"mcp-introduction",
186+
"mcp-tools"
187+
]
188+
},
182189
{
183190
"group": "Using the Dashboard",
184191
"pages": [

docs/mcp-introduction.mdx

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
---
2+
title: "MCP Introduction"
3+
sidebarTitle: "Introduction"
4+
description: "Learn how to install and configure the Trigger.dev MCP Server"
5+
tag: "new"
6+
---
7+
8+
## What is the Trigger.dev MCP Server?
9+
10+
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:
11+
12+
- Search Trigger.dev documentation
13+
- Initialize new Trigger.dev projects
14+
- List and manage your projects and organizations
15+
- Get task information and trigger task runs
16+
- Deploy projects to different environments
17+
- Monitor run details and list runs with filtering options
18+
19+
## Installation
20+
21+
### Automatic Installation (Recommended)
22+
23+
The easiest way to install the Trigger.dev MCP Server is using the interactive installation wizard:
24+
25+
```bash
26+
npx trigger.dev@latest install-mcp
27+
```
28+
29+
This command will guide you through:
30+
1. Selecting which MCP clients to configure
31+
2. Choosing installation scope (user, project, or local)
32+
3. Automatically configuring the selected clients
33+
34+
### Manual Installation
35+
36+
If you prefer manual installation or your client isn't automatically supported, you can configure it manually using:
37+
38+
```bash
39+
npx trigger.dev@latest mcp
40+
```
41+
42+
## Command Line Options
43+
44+
The `install-mcp` command supports the following options:
45+
46+
### Core Options
47+
- `-p, --project-ref <project ref>` - Scope the MCP server to a specific Trigger.dev project by providing its project ref
48+
- `-t, --tag <package tag>` - The version of the trigger.dev CLI package to use for the MCP server (default: latest or v4-beta)
49+
- `--dev-only` - Restrict the MCP server to the dev environment only
50+
- `--yolo` - Install the MCP server into all supported clients automatically
51+
- `--scope <scope>` - Choose the scope of the MCP server: `user`, `project`, or `local`
52+
- `--client <clients...>` - Choose specific client(s) to install into
53+
54+
### Configuration Options
55+
- `--log-file <log file>` - Configure the MCP server to write logs to a file
56+
- `-a, --api-url <value>` - Configure a custom Trigger.dev API URL
57+
- `-l, --log-level <level>` - Set CLI log level (debug, info, log, warn, error, none)
58+
59+
### Examples
60+
61+
Install for all supported clients:
62+
```bash
63+
npx trigger.dev@latest install-mcp --yolo
64+
```
65+
66+
Install for specific clients:
67+
```bash
68+
npx trigger.dev@latest install-mcp --client claude-code cursor --scope user
69+
```
70+
71+
Install with development environment restriction:
72+
```bash
73+
npx trigger.dev@latest install-mcp --dev-only --project-ref proj_abc123
74+
```
75+
76+
## Supported MCP Clients
77+
78+
The Trigger.dev MCP Server supports the following clients:
79+
80+
| Client | Configuration File | Documentation |
81+
|--------|-------------------|---------------|
82+
| **Claude Code** | `~/.claude.json` or `./.mcp.json` | [Claude Code MCP Docs](https://docs.anthropic.com/en/docs/claude-code/mcp) |
83+
| **Cursor** | `~/.cursor/mcp.json` or `./.cursor/mcp.json` | [Cursor MCP Docs](https://docs.cursor.com/features/mcp) |
84+
| **VSCode** | `~/Library/Application Support/Code/User/mcp.json` or `./.vscode/mcp.json` | [VSCode MCP Docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) |
85+
| **Zed** | `~/.config/zed/settings.json` | [Zed Context Servers Docs](https://zed.dev/docs/context-servers) |
86+
| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` | [Windsurf MCP Docs](https://docs.codeium.com/windsurf/mcp) |
87+
| **Gemini CLI** | `~/.gemini/settings.json` or `./.gemini/settings.json` | [Gemini CLI MCP Tutorial](https://medium.com/@joe.njenga/gemini-cli-mcp-tutorial-setup-commands-practical-use-step-by-step-example-b57f55db5f4a) |
88+
| **Charm Crush** | `~/.config/crush/crush.json` or `./crush.json` | [Charm MCP Docs](https://github.com/charmbracelet/mcp) |
89+
| **Cline** | `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json` | [Cline MCP Docs](https://github.com/saoudrizwan/claude-dev#mcp) |
90+
| **OpenAI Codex CLI** | `~/.codex/config.toml` | See OpenAI Codex CLI documentation for MCP configuration |
91+
| **Sourcegraph AMP** | `~/.config/amp/settings.json` | [Sourcegraph AMP MCP Docs](https://docs.sourcegraph.com/amp/mcp) |
92+
| **opencode** | `~/.config/opencode/opencode.json` or `./opencode.json` | [opencode MCP Docs](https://opencode.ai/docs/mcp-servers/) |
93+
94+
## Manual Configuration
95+
96+
If your client isn't directly supported by the installer, you can configure it manually. The MCP server uses the following configuration:
97+
98+
**Server Name:** `trigger`
99+
100+
**Command:** `npx`
101+
102+
**Arguments:** `["trigger.dev@latest", "mcp"]`
103+
104+
### Example JSON Configuration
105+
```json
106+
{
107+
"mcpServers": {
108+
"trigger": {
109+
"command": "npx",
110+
"args": ["trigger.dev@latest", "mcp"]
111+
}
112+
}
113+
}
114+
```
115+
116+
### Example TOML Configuration (for Codex CLI)
117+
```toml
118+
[mcp_servers.trigger]
119+
command = "npx"
120+
args = ["trigger.dev@latest", "mcp"]
121+
```
122+
123+
### Additional Options
124+
You can add these optional arguments to customize the server behavior:
125+
126+
- `--log-file <path>` - Log to a specific file
127+
- `--api-url <url>` - Use a custom Trigger.dev API URL
128+
- `--dev-only` - Restrict to dev environment only
129+
- `--project-ref <ref>` - Scope to a specific project
130+
131+
## Environment-Specific Configuration
132+
133+
### Development Only
134+
To restrict the MCP server to only work with the development environment:
135+
136+
```json
137+
{
138+
"mcpServers": {
139+
"trigger": {
140+
"command": "npx",
141+
"args": ["trigger.dev@latest", "mcp", "--dev-only"]
142+
}
143+
}
144+
}
145+
```
146+
147+
### Project-Scoped
148+
To scope the server to a specific project:
149+
150+
```json
151+
{
152+
"mcpServers": {
153+
"trigger": {
154+
"command": "npx",
155+
"args": ["trigger.dev@latest", "mcp", "--project-ref", "proj_your_project_ref"]
156+
}
157+
}
158+
}
159+
```
160+
161+
## Verification
162+
163+
After installation, restart your MCP client and look for a server named "trigger". The server should connect automatically and provide access to all Trigger.dev tools.
164+
165+
## Getting Started
166+
167+
Once installed, you can start using the MCP server by asking your AI assistant questions like:
168+
169+
- "Add trigger.dev to my project"
170+
- "List my Trigger.dev projects"
171+
- "Show me all tasks in my project"
172+
- "Trigger the email-notification task"
173+
- "How do I create a scheduled task in Trigger.dev?"
174+
- "Search Trigger.dev docs for webhook examples"
175+
176+
## Next Steps
177+
178+
- [Explore available MCP tools](/docs/mcp-tools)
179+
- [Trigger.dev Documentation](https://trigger.dev/docs)
180+
- [Join our Discord](https://trigger.dev/discord) for support

0 commit comments

Comments
 (0)