From ffbc50f7c38084239e13d20b57401592e8521c91 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 12:27:01 +0000 Subject: [PATCH 01/11] Add building with ai/skills pages and updated intro --- docs/building-with-ai.mdx | 24 ++++++++++++ docs/docs.json | 15 ++++++-- docs/images/intro-ai.jpg | Bin 0 -> 5495 bytes docs/introduction.mdx | 4 +- docs/skills.mdx | 79 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 116 insertions(+), 6 deletions(-) create mode 100644 docs/building-with-ai.mdx create mode 100644 docs/images/intro-ai.jpg create mode 100644 docs/skills.mdx diff --git a/docs/building-with-ai.mdx b/docs/building-with-ai.mdx new file mode 100644 index 0000000000..282273f9c5 --- /dev/null +++ b/docs/building-with-ai.mdx @@ -0,0 +1,24 @@ +--- +title: "Overview" +sidebarTitle: "Overview" +description: "Tools and resources for building Trigger.dev projects with AI coding assistants." +--- + +We provide tools to help you build Trigger.dev projects with AI coding assistants. We recommend using them for the best developer experience. + + + + Give your AI assistant direct access to Trigger.dev tools - search docs, trigger tasks, deploy projects, and monitor runs. + + ```bash + npx trigger.dev@latest install-mcp + ``` + + + Install pre-built prompts that teach AI assistants Trigger.dev best practices for writing tasks, configs, and more. + + ```bash + npx skills add triggerdotdev/skills + ``` + + diff --git a/docs/docs.json b/docs/docs.json index cff62e6d09..405f4eb0a2 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -43,6 +43,17 @@ "apikeys" ] }, + { + "group": "Building with AI", + "pages": [ + "building-with-ai", + { + "group": "MCP Server", + "pages": ["mcp-introduction", "mcp-tools", "mcp-agent-rules"] + }, + "skills" + ] + }, { "group": "Writing tasks", "pages": [ @@ -166,10 +177,6 @@ } ] }, - { - "group": "MCP Server", - "pages": ["mcp-introduction", "mcp-tools", "mcp-agent-rules"] - }, { "group": "Using the Dashboard", "pages": ["run-tests", "troubleshooting-alerts", "replaying", "bulk-actions"] diff --git a/docs/images/intro-ai.jpg b/docs/images/intro-ai.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9905922a22b3b586e618754f9d975831b7858f57 GIT binary patch literal 5495 zcmbuDbwCtRx4>tY1(s%kMY=;uT1q7Z0TG0SC8ZlA1?i9y7NtQ_y1N@`6c9xbBvlZQ z5@8Vug*R)w?|py2voW*xo;mm2bI+Xp-8p}M{t=+Oc|-jM0D%Ai1bhMK^FRau`y=@H zFan$q!3hcBL}bJ`A)_IqAOqhtRJ2qG@WV!b;Q~DyH!BM(w-6tnkj!Nn4GkN}|JT5I zKY)Nk=pY~QARGV`0l`B+&IbWW&`k&c#RJ{^ClDwBAs!5l4|YHRJlrh)2^4|{!zUm- zp94t23!s#Elwi-%l&9Js1xVg&iADv04;fveVnzDzBJfBeSyid+I;Aban4gEIKmd>u z@Qd?v>2r&-^@6?7L}eWYdI!4=lPvGs)Xoc+rx|t0nxp2DHEr|Lvf3SNOYH218Li3c zA0}Co6-Uixyw%>joW_`u;rOTw!vR_##&x?yHM$|9WSUy5bb#awwRPyMtw^5spzaNmVB5_(z%E+${l6*BxUhQb;b zFI2Div~!2`*$SvTTa9|k7x_PIeWtR1Vo)7$n%869E;m-#T~qxF^~G%Z^n+9qg-Pgg zx4{Y)%aVQ=6!PjS-IXPUNDZQ{O*%xXAX_&16*$boLHK&I@yiBUl9Ihni-{o)aotO-;rU#HPIrEFb z`=2|lYxjnYFwNS8kudpL(lu<7y#74Lhaa9)(^zR?D5M?`xJ3TyfOFrk)Vk*!c=_|g zo2zj^7v8&1U3=3#37^bS?!wt$y;_3g_7;yCBPg9^SH`1zBd2}nR}lFl5=umbEVMTS z+rpET4vU+FwwW@Qr0&wbHqmjj682*i-+WR&bP&RQEY%oXSh`TSd2+qBV`kKsSI75E zd~$WcWN61XCtg3tScy2HKn#vEOF{Ze*Z9;d&M{Vj2-(cmGhE%Z&-p+ znMGsL*hsVjTRpuc9UW~82_a8aQ>@^Uly^!Crij+CSi@LI-fbf!S5fav*x#Hd%1BZpjldw^T z5>yE&9SD^R@n9=0O!ZKsMQFA>r$RJCnM}y*XFNedKbR?A9%FOd(o(^0{P)L<3>P+v*>x=z3K@mpx0F-_TGSuq2KW6@T*;X#Qe4_JeD-7upwSv~lzLALOUd12UCgRK5> zvoN*8_{$gLO=)^62yid}aID($;V(kw=M~?mAbzZe#8;pLM5suSGE%V@#la!|NJ9c7 zZ;_0otXhHKiwH^pVTkFYD;p;jEc&PL=SUC=0KNa32*H|kg%W^3@n8gSd>91w+Zy;2 zfFbay*zyS|MMP1agzRDpx|R>>sW}vNJZO{>C&iJR+67i&{a|T=gB1%R5A3F3ROFW@ zWK|?*&>qtQ$hc}fOh_N|x~b$$moBh-b4LJM(R~_-A^?|XiLczWIQYH<#(5JnH^}PMWJBEjjDE z7al_I#ST1>8T!=xYr3FmX6X{*8^Z{8uxg%%Co3 zWcTo|Q{tF7NVc9k>2hI&J(7t7oRh(GmB0x9yBm=~%~)oyU9aB9>)(Q!XWDcbPMz0e zE9;AN(URWIMJPU+IZnUTYl~|M&-R7WSHNa(18X5ZN!c$>#-=0L#jcl=3R7-r+`1`S zQbOnPgy2AkoBxc|0L_sFbGuS;IHH;GzP6>uIx4dgId|a0mf=kDog4adzQT03dN3=` z#=0m2)@?hc6+yDU3oAD_iJdX^8jPDuFbGE@aNBwtwD!$U4jYj0hu zYnZRDZhpL>%@%(>tW9SQ4Bgb_0&@P3_rT!Ql`vB$oCDf#NF)m~^T`9z`>j~}%A$6P za7XnCF7I1n+BJ5s4!jTCV??bwTEc>5f)uf*&-Pd!1@Um){&h{!sq>^ZUfF~8i<`fG zdLZ$Hd=Vlt=EBiVme3lJ!fC<< z*0Px*V-xnmkC*ezGqo!W)r$!iRljfq+&+l9TPA_^ER(;HAn>!IUQ$X@cH_RC?_&%q(p4#nOMvX~W&#jIvfv(&y$8?EV zuKrs3jy(fA+{+qw3yJ-N>A1DnDQsdA>}))3wks>n*QBI=rwS&9Mvr!sJU?0F z`6e@>PTd#FVx}jsmJz5I^!kI*M0y<8{doTF&h$Zc+_G^(xmQbgmadC!3#}t(|KuWh zeD!e$-)G5-;miCLXViuXU*^WFHnKDQZSU|EI*gV|C)96u3Zk@B(lq&eDbmmM{3rO@ z`P2`4Xr>z73L_nf=?BjN)ily~XyLtL8egQJe19eNFUEONz0q6Z61jQj00VY&f_HmN zY1~~(=HeEyTy0$8k=!G-Io(6+;#rwiIwKlxLSHPaVRmkIlbP_#@wU^H;?>O8K@Z1hK)t5_SNhsn)JHJUJur!C31X|bQ;fAm%9MJ zYJW8ConuezbHaL8)kze7ujSc`AvH=Obr=JJiovLe)*DYhxl-X*99Sgfcc_?oIxc3M zO7fppN9vwcoGp*N*&?1snb_UEyxA)8rLFMjgh{`++vfd?s_kV)9VA(NhW%^hb3nb} zMOOx+j4NxwlD66zzEy~pM4W%&_h+Swzp6+wzE?_nubUaCZN+-n`=_Y$PHoAt6Ya3* z?nG}B3~W>>;p$~i=I~XDw^HeTS+Z|@t5dV8uQg7G9}r)WmUyL+Y8}qWm47l+gsd%# zN(wm<*{Zp=yx=_~#L%sb6zksbqt!e+X$s8h?7>yzRF-$xmLhp zJL{wW_9b5{r9;t0?eI174i%4daMW6tw%PW1b5YE;Y(eIMU7%6RPL_x!B@5h~{|t5S z-5YSFMw(YwA;-2xNLJhSY0r{M=!j{%lPK4dYYb?#kXQ9oY1L3pzVTIiQ|%;ba*Czn zXKCB{d^f46QbK_|yfU(T)95V6g6+@Aw}UXrSc<+S&YMjPHq;*b?|;sG70r*q^3Vmvq$O-ouuo6%r{+a+ zoxx`u9l2v|QhA($n%W4DlCiZ%h++n>SYypudOq)#v4}ubrs7pDhS!izq@;l{u4*r3 zgGF(x%KNS}5*KpA*Yh4*Jkw7c+CntNKDvAk;;+f8)iic?>9jWdT-Vu1O>(4JxtZ8~ zld>2|RZOKW$+gRCc?Z73f)4OO#C3pZ!EqeNFfxz698jq0a^EG3U*Galu~yWZCvPZ> z_3_E9Z|_7^3mBEqc}b5K5IZGn-_faPp27E!>e{cIqwq6#2^?Xz>evWtQ{-q8)zphC zt1_?%$KtHZuHZWD4XgA8n2kFME74ZFykXscgO z;Jwz$k5iRD#77Sf@)xomfsh4G1#=9qO^DZQ_7-lceer%;AS&Izd0L=B3rC!(a|UYy zAIhuceo^@AV{xG%^p~5E{kVy-DydKr(HE#=-Sgi40MalU0^Djt!5#Yl?!+Mg0!9VJ z#{*fIP2o53LLm?+@Ux=Q)VreM9Kc8Gcf3QRovYEop-40uUDJ$4tHm4v_yChrMMXuW z!DBQB?>I;66M2w%80Fc zk6$4VDV_#idzByfC|EQe?6ZU`vBH%oJx*O)XL-!@Z#VdP(hAUxtk4aM;H*(9EBoKg zbr^kSFmT8ui3aoLk@Yv_Fb)n*pRMkmVDnl(RnAEcP6Prd!! zR;N~{b3lpnzGr9W+^%zHYtkGT4l7Qd0GF0|@NK$SQM=;vR~kO-`1rKU;9Adtw6DA0 z!B~qS04TWEz{e-V|NGbjw-G@AREqf2?4k;k9F`u5G@LppEBAacaV5_O^?##}Cl8!b z8CYX>_Lf`+vpU_M`&U#Ky@AsN)RE9$W^$jDD~uHr)n|o@r~^>-As3tSu9)ShANH2k zZh!})lBK}cQJb-Yx#=Nqn)tK}X#zh?@sE5TjL~u-tfyS>-~SdTF5~vioo>NJMvaLZ zs(AKI+B8SMvB_u{)iPzSgJJjqk3(I5!DRS!l$cPov+=o10ZC%y95P8y(4?-H#CbsX z?W-mpB8KeN-5!ic!gU%o!LoeSgaL!zc*?GNvw=0jTcCF+_+_?OMAQv^)O9`>BA>41 zxn$_0VbX!qM7Pth!6aApcHR=>(dTTAVua4L!{cFt{kHP-Waj`=U1FJ@3YsaDmbs}} zz8fkZ!xZG9LMDM7+@V(yO35n!Hkj4DwAWyE?CKJ7sn7v6@1u9fIuvJl+?%NqRgENJ z6pS4`yP7cBi@i0ivw6GMssW|UZfUOnUAnx&%}+2X2g3E;uF_stM#@4=D)Za0f0<+7 zCk8vtP1j+ywF)n`?o{FZID0Y;vwc|8J)e|~AXT)caw_H2SfV<4)ZpG{Rnh=cTjdkE zq@Fubmz4^Mb6%IdS`_naeQ-qt4x_x0HYBS&oL`98dO8~-J^RwgpHj?*z9IIK8+l#B zE4AH|fW0uUDbfJ5$y78}g~CJ7*If579?TUM1OS2k*Ml=W2o%f}1xhv%?caF;-m*~O zpeD84{C<~!3)kI*@;)2G&t5eflUKMq1Rja0_Ki@UTuLNfzaeH-Koa@(7Uv?LK@_D} zW#p9ATxOwfbMb?rwZY{TTwf z!;ec{JSdC++$#SO2owR}u~R8fit1QWbBZatdnlo-9_0UZ4NTc1-idE3)YKgsI%U{A z1-6ghT0#d1uHw_@`emx(v9Ub7CuRK|S@C=aBc)v?Y9JKDp{mor+Q+7_=`gR*DCgbO zaQk(^xFMD&vV^@`NFnrw3Y2Xo_tQBbjCFOHw}V=s*M1gm#)#e8^EzlpdgP!(#jG4| z^*-&4z5Np35kDb$KKzbFrGA>E27@x4c4zm6J0Vv2^c_#B(2&(+#hnK-cU&_+>Fe+& pR?|-U6Zfc1%39BdQ%Q^;R_0$B$XK$yLq6POO!wl&QT+Mr{{UzMte*e? literal 0 HcmV?d00001 diff --git a/docs/introduction.mdx b/docs/introduction.mdx index fa57a45860..383040de14 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -16,8 +16,8 @@ mode: "center" > Browse our wide range of guides, frameworks and example projects - - Learn how to install and configure the Trigger.dev MCP Server + + Learn how to build Trigger.dev projects using AI coding assistants Watch an end-to-end demo of Trigger.dev in 10 minutes diff --git a/docs/skills.mdx b/docs/skills.mdx new file mode 100644 index 0000000000..fab54858d6 --- /dev/null +++ b/docs/skills.mdx @@ -0,0 +1,79 @@ +--- +title: "Skills" +description: "Install Trigger.dev skills to teach any AI coding assistant best practices for writing tasks, agents, and workflows." +--- + +## What are agent skills? + +Skills are portable instruction sets that teach AI coding assistants how to use Trigger.dev effectively. Unlike vendor-specific config files (`.cursor/rules`, `CLAUDE.md`), skills use an open standard that works across all major AI assistants. For example, Cursor users and Claude Code users can get the same knowledge from a single install. + +Skills install as `SKILL.md` files that AI assistants automatically discover and follow. Each skill contains YAML frontmatter (name, description) and markdown instructions with patterns, examples, and best practices. + +## Installation + +When you run `npx skills add triggerdotdev/skills`, the CLI detects your installed AI tools and copies the appropriate files to each tool's expected location. For example, `.claude/skills/`, `.cursor/rules/`, `.github/copilot-instructions/`, etc. + +```bash +npx skills add triggerdotdev/skills +``` + +`skills` is an open-source CLI by Vercel. Learn more at [skills.sh](https://skills.sh). + +The result: your AI assistant understands Trigger.dev's specific patterns for exports, schema validation, error handling, retries, and more. + +## Supported AI assistants + +Skills work with any AI coding assistant that supports the [Agent Skills standard](https://agentskills.io), including: + +- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) +- [Cursor](https://cursor.com) +- [Windsurf](https://codeium.com/windsurf) +- [GitHub Copilot](https://github.com/features/copilot) +- [Cline](https://github.com/cline/cline) +- [Codex CLI](https://github.com/openai/codex) +- [Gemini CLI](https://github.com/google-gemini/gemini-cli) +- [OpenCode](https://opencode.ai) +- [View all →](https://skills.sh/docs/supported-agents) + +## Available skills + +Install all skills at once, or pick the ones relevant to your current work: + +```bash +# Install all Trigger.dev skills +npx skills add triggerdotdev/skills + +# Or install individual skills +npx skills add triggerdotdev/skills --skill trigger-tasks +npx skills add triggerdotdev/skills --skill trigger-agents +npx skills add triggerdotdev/skills --skill trigger-config +npx skills add triggerdotdev/skills --skill trigger-realtime +npx skills add triggerdotdev/skills --skill trigger-setup +``` + +| Skill | Use for | Covers | +|-------|---------|--------| +| `trigger-setup` | First time setup, new projects | SDK install, `npx trigger init`, project structure | +| `trigger-tasks` | Writing background tasks, async workflows, scheduled tasks | Triggering, waits, queues, retries, cron, metadata | +| `trigger-agents` | LLM workflows, orchestration, multi-step AI agents | Prompt chaining, routing, parallelization, human-in-the-loop | +| `trigger-realtime` | Live updates, progress indicators, streaming | React hooks, progress bars, streaming AI responses | +| `trigger-config` | Project setup, build configuration | `trigger.config.ts`, extensions (Prisma, FFmpeg, Playwright) | + +Not sure which skill to install? Install `trigger-tasks`; it covers the most common patterns for writing Trigger.dev tasks. + +## Next steps + + + + Give your AI assistant direct access to Trigger.dev tools and APIs. + + + Learn the task patterns that skills teach your AI assistant. + + + Build durable AI workflows with prompt chaining and human-in-the-loop. + + + Browse the full Agent Skills ecosystem. + + \ No newline at end of file From 11775af82db32857f9e96873155ee5d62d1ff639 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 13:41:50 +0000 Subject: [PATCH 02/11] Fix skills installation paths in docs Update example paths to use correct skill directories: - .cursor/skills/ (not .cursor/rules/) - .github/skills/ (not .github/copilot-instructions/) --- docs/skills.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/skills.mdx b/docs/skills.mdx index fab54858d6..5f7a51bf31 100644 --- a/docs/skills.mdx +++ b/docs/skills.mdx @@ -11,7 +11,7 @@ Skills install as `SKILL.md` files that AI assistants automatically discover and ## Installation -When you run `npx skills add triggerdotdev/skills`, the CLI detects your installed AI tools and copies the appropriate files to each tool's expected location. For example, `.claude/skills/`, `.cursor/rules/`, `.github/copilot-instructions/`, etc. +When you run `npx skills add triggerdotdev/skills`, the CLI detects your installed AI tools and copies the appropriate files to each tool's expected location. For example, `.claude/skills/`, `.cursor/skills/`, `.github/skills/`, etc. ```bash npx skills add triggerdotdev/skills From 2e91071de496855ad10f3364cde9b8cfc07684d3 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 15:29:01 +0000 Subject: [PATCH 03/11] More copy tweaks --- docs/skills.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/skills.mdx b/docs/skills.mdx index 5f7a51bf31..262b5ca767 100644 --- a/docs/skills.mdx +++ b/docs/skills.mdx @@ -7,7 +7,7 @@ description: "Install Trigger.dev skills to teach any AI coding assistant best p Skills are portable instruction sets that teach AI coding assistants how to use Trigger.dev effectively. Unlike vendor-specific config files (`.cursor/rules`, `CLAUDE.md`), skills use an open standard that works across all major AI assistants. For example, Cursor users and Claude Code users can get the same knowledge from a single install. -Skills install as `SKILL.md` files that AI assistants automatically discover and follow. Each skill contains YAML frontmatter (name, description) and markdown instructions with patterns, examples, and best practices. +Skills are installed as directories containing a `SKILL.md` file. Each `SKILL.md` includes YAML frontmatter (name, description) and markdown instructions with patterns, examples, and best practices that AI assistants automatically discover and follow. ## Installation From dc3c6adcecf4bf3d005d6ff2257ca174c2aa9217 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 20:36:47 +0000 Subject: [PATCH 04/11] Simplified MCP tools page --- docs/mcp-tools.mdx | 532 ++++++--------------------------------------- 1 file changed, 69 insertions(+), 463 deletions(-) diff --git a/docs/mcp-tools.mdx b/docs/mcp-tools.mdx index 0163de97a4..9db838d323 100644 --- a/docs/mcp-tools.mdx +++ b/docs/mcp-tools.mdx @@ -1,527 +1,133 @@ --- title: "MCP Tools" sidebarTitle: "Tools" -description: "Learn about the tools available in the Trigger.dev MCP Server" -tag: "new" +description: "Learn about how to use the tools available in the Trigger.dev MCP Server" --- -The Trigger.dev MCP Server provides a comprehensive set of tools that enable AI assistants to interact with your Trigger.dev projects. These tools cover everything from project management to task execution and monitoring. - ## Documentation and Search Tools ### search_docs -Search across the Trigger.dev documentation to find relevant information, code examples, API references, and guides. +Search the Trigger.dev documentation for guides, examples, and API references. - - The search query to find information in the Trigger.dev documentation - +**Example usage:** +- _"How do I create a scheduled task?"_ +- _"Show me webhook examples"_ +- _"What are the deployment options?"_ -**Usage Examples:** +## Project Management Tools -- "How do I create a scheduled task?" -- "webhook examples" -- "deployment configuration" -- "error handling patterns" +### list_orgs - -```json Example Usage -{ - "tool": "search_docs", - "arguments": { - "query": "webhook examples" - } -} -``` - +List all organizations you have access to. -## Project Management Tools +**Example usage:** +- _"What organizations do I have?"_ +- _"Show me my orgs"_ ### list_projects List all projects in your Trigger.dev account. -**No parameters required** - - - Array of project objects containing project details, IDs, and metadata - - - -```json Example Response -{ - "projects": [ - { - "id": "proj_abc123", - "name": "My App", - "slug": "my-app", - "organizationId": "org_xyz789" - } - ] -} -``` - - -### list_orgs - -List all organizations you have access to. - -**No parameters required** - - - Array of organization objects containing organization details and metadata - +**Example usage:** +- _"What projects do I have?"_ +- _"List my Trigger.dev projects"_ ### create_project_in_org Create a new project in an organization. - - The organization to create the project in, can either be the organization slug or the ID. Use the - `list_orgs` tool to get a list of organizations and ask the user to select one. - - - - The name of the project to create - - - -```json Example Usage -{ - "tool": "create_project_in_org", - "arguments": { - "orgParam": "my-org", - "name": "New Project" - } -} -``` - +**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. - - The organization to create the project in, can either be the organization slug or the ID. Use the - `list_orgs` tool to get a list of organizations and ask the user to select one. - - - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - +**Example usage:** +- _"Set up Trigger.dev in this project"_ +- _"Add Trigger.dev to my app"_ - - The name of the project to create. If projectRef is not provided, we will use this name to create - a new project in the organization you select. - +## Task Management Tools - - The current working directory of the project - +### get_current_worker -## Task Management Tools +Get all tasks registered in a project along with their payload schemas. -### get_tasks - -Get all tasks in a project. - - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - - - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). If not provided, we will try to find the config file in the - current working directory. - - - - The environment to get tasks for. Options: `dev`, `staging`, `prod`, `preview` - - - - The branch to get tasks for, only used for preview environments - - - -```json Example Usage -{ - "tool": "get_tasks", - "arguments": { - "projectRef": "proj_abc123", - "environment": "dev" - } -} -``` - +**Example usage:** +- _"What tasks are available?"_ +- _"Show me the tasks in dev"_ ### trigger_task -Trigger a task to run. - - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - - - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). - - - - The environment to trigger the task in. Options: `dev`, `staging`, `prod`, `preview` - - - - The branch to trigger the task in, only used for preview environments - - - - The ID/slug of the task to trigger. Use the `get_tasks` tool to get a list of tasks and ask the - user to select one if it's not clear which one to use. - - - - The payload to trigger the task with, must be a valid JSON string - - - - Additional options for the task run - - - The name of the queue to trigger the task in, by default will use the queue configured in the - task - - - The delay before the task run is executed - - - The idempotency key to use for the task run - - - The machine preset to use for the task run. Options: `micro`, `small-1x`, `small-2x`, - `medium-1x`, `medium-2x`, `large-1x`, `large-2x` - - - The maximum number of attempts to retry the task run - - - The maximum duration in seconds of the task run - - - Tags to add to the task run. Must be less than 128 characters and cannot have more than 5 - - - The time to live of the task run. If the run doesn't start executing within this time, it will - be automatically cancelled. - - - - - -```json Example Usage -{ - "tool": "trigger_task", - "arguments": { - "projectRef": "proj_abc123", - "taskId": "email-notification", - "payload": "{\"email\": \"user@example.com\", \"subject\": \"Hello World\"}", - "options": { - "tags": ["urgent"], - "maxAttempts": 3 - } - } -} -``` - +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 the details of a specific task run. +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. - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - +**Example usage:** +- _"Show me details for run run_abc123"_ +- _"Why did this run fail?"_ - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). - +### list_runs + +List runs for a project. Filter by status, task, tags, version, machine size, or time period. - - The environment to get the run details from. Options: `dev`, `staging`, `prod`, `preview` - +**Example usage:** +- _"Show me recent runs"_ +- _"List failed runs from the last 7 days"_ +- _"What runs are currently executing?"_ - - The branch to get the run details from, only used for preview environments - +### wait_for_run_to_complete - - The ID of the run to get the details of, starts with `run_` - +Wait for a specific run to finish and return the result. - - Enable debug mode to get more detailed information about the run, including the entire trace (all logs and spans for the run and any child run). Set this to true if prompted to debug a run. - +**Example usage:** +- _"Wait for run run_abc123 to complete"_ ### cancel_run -Cancel a running task. - - - The ID of the run to cancel, starts with `run_` - - - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - - - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). - - - - The environment to cancel the run in. Options: `dev`, `staging`, `prod`, `preview` - - - - The branch to cancel the run in, only used for preview environments - - - -```json Example Usage -{ - "tool": "cancel_run", - "arguments": { - "runId": "run_abc123", - "projectRef": "proj_abc123" - } -} -``` - +Cancel a running or queued task. -### list_runs - -List all runs for a project with comprehensive filtering options. - - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - - - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). - - - - The environment to list runs from. Options: `dev`, `staging`, `prod`, `preview` - - - - The branch to list runs from, only used for preview environments - - - - The cursor to use for pagination, starts with `run_` - - - - The number of runs to list in a single page. Up to 100 - - - - Filter for runs with this run status. Options: `PENDING_VERSION`, `QUEUED`, `DEQUEUED`, - `EXECUTING`, `WAITING`, `COMPLETED`, `CANCELED`, `FAILED`, `CRASHED`, `SYSTEM_FAILURE`, `DELAYED`, - `EXPIRED`, `TIMED_OUT` - - - - Filter for runs that match this task identifier - - - - Filter for runs that match this version, e.g. `20250808.3` - - - - Filter for runs that include this tag - - - - Filter for runs created after this ISO 8601 timestamp - - - - Filter for runs created before this ISO 8601 timestamp - - - - Filter for runs created in the last N time period. Examples: `7d`, `30d`, `365d` - - - - Filter for runs that match this machine preset. Options: `micro`, `small-1x`, `small-2x`, - `medium-1x`, `medium-2x`, `large-1x`, `large-2x` - - - -```json Example Usage -{ - "tool": "list_runs", - "arguments": { - "projectRef": "proj_abc123", - "status": "COMPLETED", - "limit": 10, - "period": "7d" - } -} -``` - +**Example usage:** +- _"Cancel run run_abc123"_ +- _"Stop that task"_ ## Deployment Tools ### deploy -Deploy a project to staging or production environments. - - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - - - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). - - - - The environment to deploy to. Options: `staging`, `prod`, `preview` - - - - The branch to deploy, only used for preview environments - - - - Skip promoting the deployment to the current deployment for the environment - - - - Skip syncing environment variables when using the syncEnvVars extension - - - - Skip checking for @trigger.dev package updates - - - -```json Example Usage -{ - "tool": "deploy", - "arguments": { - "projectRef": "proj_abc123", - "environment": "prod", - "skipUpdateCheck": true - } -} -``` - - -### list_deployments - -List deployments for a project with comprehensive filtering options. - - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - - - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). - - - - The environment to list deployments for. Options: `staging`, `prod`, `preview` - - - - The branch to list deployments from, only used for preview environments - - - - The deployment ID to start the search from, to get the next page - - - - The number of deployments to return, defaults to 20 (max 100) - - - - Filter deployments that are in this status. Options: `PENDING`, `BUILDING`, `DEPLOYING`, `DEPLOYED`, `FAILED`, `CANCELED`, `TIMED_OUT` - - - - The date to start the search from, in ISO 8601 format - - - - The date to end the search, in ISO 8601 format - - - - The period to search within. Examples: `1d`, `7d`, `3h` - - - -```json Example Usage -{ - "tool": "list_deployments", - "arguments": { - "projectRef": "proj_abc123", - "environment": "prod", - "status": "DEPLOYED", - "limit": 10 - } -} -``` - +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. - - The trigger.dev project ref, starts with `proj_`. We will attempt to automatically detect the - project ref if running inside a directory that includes a trigger.config.ts file. - - - - The path to the trigger.config.ts file. Only used when the trigger.config.ts file is not at the - root dir (like in a monorepo setup). If not provided, we will try to find the config file in the - current working directory. - - - -```json Example Usage -{ - "tool": "list_preview_branches", - "arguments": { - "projectRef": "proj_abc123" - } -} -``` - +**Example usage:** +- _"What preview branches exist?"_ +- _"Show me preview deployments"_ - The deploy tool and list_preview_branches tool are not available when the MCP server is running with the `--dev-only` flag. + The deploy and list_preview_branches tools are not available when the MCP server is running with the `--dev-only` flag. From f151f010061a64791674bc1f3b28b745f377ee96 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 20:36:56 +0000 Subject: [PATCH 05/11] Added new badge to skills and removed new badge from mcp pages --- docs/mcp-agent-rules.mdx | 1 - docs/mcp-introduction.mdx | 1 - docs/skills.mdx | 2 ++ 3 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/mcp-agent-rules.mdx b/docs/mcp-agent-rules.mdx index 664d8bcf29..321f312a84 100644 --- a/docs/mcp-agent-rules.mdx +++ b/docs/mcp-agent-rules.mdx @@ -2,7 +2,6 @@ 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? diff --git a/docs/mcp-introduction.mdx b/docs/mcp-introduction.mdx index d9dc3474e1..c00aa60d9f 100644 --- a/docs/mcp-introduction.mdx +++ b/docs/mcp-introduction.mdx @@ -2,7 +2,6 @@ title: "MCP Introduction" sidebarTitle: "Introduction" description: "Learn how to install and configure the Trigger.dev MCP Server" -tag: "new" --- ## What is the Trigger.dev MCP Server? diff --git a/docs/skills.mdx b/docs/skills.mdx index 262b5ca767..8c38fc1875 100644 --- a/docs/skills.mdx +++ b/docs/skills.mdx @@ -1,6 +1,8 @@ --- title: "Skills" description: "Install Trigger.dev skills to teach any AI coding assistant best practices for writing tasks, agents, and workflows." +sidebarTitle: "Skills" +tag: "new" --- ## What are agent skills? From bcf79e873a9a02c10e0ec541ca8fb2f1520ed6a7 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 20:38:49 +0000 Subject: [PATCH 06/11] Reordered skills page --- docs/skills.mdx | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/skills.mdx b/docs/skills.mdx index 8c38fc1875..de2c7ccea6 100644 --- a/docs/skills.mdx +++ b/docs/skills.mdx @@ -23,19 +23,6 @@ npx skills add triggerdotdev/skills The result: your AI assistant understands Trigger.dev's specific patterns for exports, schema validation, error handling, retries, and more. -## Supported AI assistants - -Skills work with any AI coding assistant that supports the [Agent Skills standard](https://agentskills.io), including: - -- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) -- [Cursor](https://cursor.com) -- [Windsurf](https://codeium.com/windsurf) -- [GitHub Copilot](https://github.com/features/copilot) -- [Cline](https://github.com/cline/cline) -- [Codex CLI](https://github.com/openai/codex) -- [Gemini CLI](https://github.com/google-gemini/gemini-cli) -- [OpenCode](https://opencode.ai) -- [View all →](https://skills.sh/docs/supported-agents) ## Available skills @@ -63,6 +50,21 @@ npx skills add triggerdotdev/skills --skill trigger-setup Not sure which skill to install? Install `trigger-tasks`; it covers the most common patterns for writing Trigger.dev tasks. + +## Supported AI assistants + +Skills work with any AI coding assistant that supports the [Agent Skills standard](https://agentskills.io), including: + +- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) +- [Cursor](https://cursor.com) +- [Windsurf](https://codeium.com/windsurf) +- [GitHub Copilot](https://github.com/features/copilot) +- [Cline](https://github.com/cline/cline) +- [Codex CLI](https://github.com/openai/codex) +- [Gemini CLI](https://github.com/google-gemini/gemini-cli) +- [OpenCode](https://opencode.ai) +- [View all →](https://skills.sh/docs/supported-agents) + ## Next steps From a50aa058fa0a504a7eb07e04c36e0311ddffb6bf Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 20:42:37 +0000 Subject: [PATCH 07/11] Rabbit fixes --- docs/mcp-tools.mdx | 2 +- docs/skills.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/mcp-tools.mdx b/docs/mcp-tools.mdx index 9db838d323..64688a21cf 100644 --- a/docs/mcp-tools.mdx +++ b/docs/mcp-tools.mdx @@ -96,7 +96,7 @@ Wait for a specific run to finish and return the result. ### cancel_run -Cancel a running or queued task. +Cancel a running or queued run. **Example usage:** - _"Cancel run run_abc123"_ diff --git a/docs/skills.mdx b/docs/skills.mdx index de2c7ccea6..eb4add4795 100644 --- a/docs/skills.mdx +++ b/docs/skills.mdx @@ -63,7 +63,7 @@ Skills work with any AI coding assistant that supports the [Agent Skills standar - [Codex CLI](https://github.com/openai/codex) - [Gemini CLI](https://github.com/google-gemini/gemini-cli) - [OpenCode](https://opencode.ai) -- [View all →](https://skills.sh/docs/supported-agents) +- [View all →](https://skills.sh) ## Next steps From 3ad630ee333788435cf5c9d1cb1d155e4ef6f5ba Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 28 Jan 2026 20:54:45 +0000 Subject: [PATCH 08/11] Improved get_current_worker description --- docs/mcp-tools.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mcp-tools.mdx b/docs/mcp-tools.mdx index 64688a21cf..058a3671ab 100644 --- a/docs/mcp-tools.mdx +++ b/docs/mcp-tools.mdx @@ -53,7 +53,7 @@ Initialize Trigger.dev in your project with automatic setup and configuration. ### get_current_worker -Get all tasks registered in a project along with their payload schemas. +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?"_ From 4a95db768e8915f724c22ae3c15d46c93b2d66ba Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Thu, 29 Jan 2026 12:53:40 +0000 Subject: [PATCH 09/11] Updated MCP intro page layout --- docs/mcp-introduction.mdx | 400 +++++++++++++++++++++++++++----------- 1 file changed, 290 insertions(+), 110 deletions(-) diff --git a/docs/mcp-introduction.mdx b/docs/mcp-introduction.mdx index c00aa60d9f..02a9157d94 100644 --- a/docs/mcp-introduction.mdx +++ b/docs/mcp-introduction.mdx @@ -17,44 +17,308 @@ The Trigger.dev MCP (Model Context Protocol) Server enables AI assistants to int ## Installation -### Automatic Installation (Recommended) - -The easiest way to install the Trigger.dev MCP Server is using the interactive installation wizard: +The quickest way to get set up is the interactive installer: ```bash npx trigger.dev@latest install-mcp ``` -This command will guide you through: +It will detect your installed clients and configure them automatically. You can also copy-paste the config for your client below. -1. Selecting which MCP clients to configure -2. Choosing installation scope (user, project, or local) -3. Automatically configuring the selected clients +## Client Configuration -## Command Line Options +Each client has a slightly different config format. Copy the snippet for your client into the appropriate file. -The `install-mcp` command supports the following options: + + + Install using the command line: -### Core Options + ```bash + npx trigger.dev@latest install-mcp --client claude-code + ``` -- `-p, --project-ref ` - Scope the MCP server to a specific Trigger.dev project by providing its project ref -- `-t, --tag ` - The version of the trigger.dev CLI package to use for the MCP server (default: latest or v4-beta) -- `--dev-only` - Restrict the MCP server to the dev environment only -- `--yolo` - Install the MCP server into all supported clients automatically -- `--scope ` - Choose the scope of the MCP server: `user`, `project`, or `local` -- `--client ` - Choose specific client(s) to install into + Or add this configuration to `~/.claude.json` (user) or `.mcp.json` (project): -### Configuration Options + ```json + { + "mcpServers": { + "trigger": { + "command": "npx", + "args": ["trigger.dev@latest", "mcp"] + } + } + } + ``` + + [View Claude Code MCP docs ↗](https://code.claude.com/docs/en/mcp) + + + 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) + + + 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) + + + 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"] + } + } + } + ``` + + VS Code uses `servers` instead of `mcpServers`. + + [View VS Code MCP docs ↗](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) + + + 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) + + + 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) + + + 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"] + } + } + } + ``` + + + 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) + + + 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"] + ``` + + + Install using the command line: + + ```bash + npx trigger.dev@latest install-mcp --client crush + ``` + + Or add this configuration to `~/.config/crush/crush.json` (user), `./crush.json` (project), or `./.crush.json` (local): + + ```json + { + "mcp": { + "trigger": { + "type": "stdio", + "command": "npx", + "args": ["trigger.dev@latest", "mcp"] + } + } + } + ``` + + [View Charm MCP docs ↗](https://github.com/charmbracelet/crush) + + + 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/) + + + 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"] + } + } + } + ``` + + -- `--log-file ` - Configure the MCP server to write logs to a file -- `-a, --api-url ` - Configure a custom Trigger.dev API URL -- `-l, --log-level ` - Set CLI log level (debug, info, log, warn, error, none) +After adding the config, restart your client. You should see a server named **trigger** connect automatically. ## Authentication -You can use the MCP server without authentication with the `search_docs` tool, but for any other tool call you will need to authenticate the MCP server via the same method as the [Trigger.dev CLI](/cli-login-commands).The first time you attempt to use a tool that requires authentication, you will be prompted to authenticate the MCP server via the MCP client. +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. + + -### Examples +The `install-mcp` command supports these options: + +**Core Options** + +- `-p, --project-ref ` — Scope the MCP server to a specific project +- `-t, --tag ` — CLI package version to use (default: latest) +- `--dev-only` — Restrict to the dev environment only +- `--yolo` — Install into all supported clients automatically +- `--scope ` — `user`, `project`, or `local` +- `--client ` — Install into specific client(s) + +**Configuration Options** + +- `--log-file ` — Write logs to a file +- `-a, --api-url ` — Custom Trigger.dev API URL +- `-l, --log-level ` — Log level (debug, info, log, warn, error, none) + +**Examples** Install for all supported clients: @@ -68,105 +332,21 @@ Install for specific clients: npx trigger.dev@latest install-mcp --client claude-code cursor --scope user ``` -Install with development environment restriction: +Restrict to dev environment for a specific project: ```bash npx trigger.dev@latest install-mcp --dev-only --project-ref proj_abc123 ``` -## Supported MCP Clients - -The Trigger.dev MCP Server supports the following clients: - -| Client | Scope Options | Configuration File | Documentation | -| -------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| **Claude Code** | user, project, local | `~/.claude.json` or `./.mcp.json` (project/local scope) | [Claude Code MCP Docs](https://docs.anthropic.com/en/docs/claude-code/mcp) | -| **Cursor** | user, project | `~/.cursor/mcp.json` (user) or `./.cursor/mcp.json` (project) | [Cursor MCP Docs](https://docs.cursor.com/features/mcp) | -| **VSCode** | user, project | `~/Library/Application Support/Code/User/mcp.json` (user) or `./.vscode/mcp.json` (project) | [VSCode MCP Docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) | -| **Zed** | user | `~/.config/zed/settings.json` | [Zed Context Servers Docs](https://zed.dev/docs/context-servers) | -| **Windsurf** | user | `~/.codeium/windsurf/mcp_config.json` | [Windsurf MCP Docs](https://docs.codeium.com/windsurf/mcp) | -| **Gemini CLI** | user, project | `~/.gemini/settings.json` (user) or `./.gemini/settings.json` (project) | [Gemini CLI MCP Tutorial](https://medium.com/@joe.njenga/gemini-cli-mcp-tutorial-setup-commands-practical-use-step-by-step-example-b57f55db5f4a) | -| **Charm Crush** | user, project, local | `~/.config/crush/crush.json` (user), `./crush.json` (project), or `./.crush.json` (local) | [Charm MCP Docs](https://github.com/charmbracelet/mcp) | -| **Cline** | user | `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json` | [Cline MCP Docs](https://github.com/saoudrizwan/claude-dev#mcp) | -| **OpenAI Codex CLI** | user | `~/.codex/config.toml` | See OpenAI Codex CLI documentation for MCP configuration | -| **Sourcegraph AMP** | user | `~/.config/amp/settings.json` | [Sourcegraph AMP MCP Docs](https://docs.sourcegraph.com/amp/mcp) | -| **opencode** | user, project | `~/.config/opencode/opencode.json` (user) or `./opencode.json` (project) | [opencode MCP Docs](https://opencode.ai/docs/mcp-servers/) | - -## Manual Configuration - -If your client isn't directly supported by the installer, you can configure it manually. The MCP server uses the following configuration: - -**Server Name:** `trigger` - -**Command:** `npx` - -**Arguments:** `["trigger.dev@latest", "mcp"]` - -### Example JSON Configuration +To add these options to a manual config, append them to the `args` array: ```json { - "mcpServers": { - "trigger": { - "command": "npx", - "args": ["trigger.dev@latest", "mcp"] - } - } + "args": ["trigger.dev@latest", "mcp", "--dev-only", "--project-ref", "proj_abc123"] } ``` -### Example TOML Configuration (for Codex CLI) - -```toml -[mcp_servers.trigger] -command = "npx" -args = ["trigger.dev@latest", "mcp"] -``` - -### Additional Options - -You can add these optional arguments to customize the server behavior: - -- `--log-file ` - Log to a specific file -- `--api-url ` - Use a custom Trigger.dev API URL -- `--dev-only` - Restrict to dev environment only -- `--project-ref ` - Scope to a specific project - -## Environment-Specific Configuration - -### Development Only - -To restrict the MCP server to only work with the development environment: - -```json -{ - "mcpServers": { - "trigger": { - "command": "npx", - "args": ["trigger.dev@latest", "mcp", "--dev-only"] - } - } -} -``` - -### Project-Scoped - -To scope the server to a specific project: - -```json -{ - "mcpServers": { - "trigger": { - "command": "npx", - "args": ["trigger.dev@latest", "mcp", "--project-ref", "proj_your_project_ref"] - } - } -} -``` - -## Verification - -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. + ## Getting Started From 07859b07edce912cd1d42a35752de2b7df6c3dec Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Thu, 29 Jan 2026 13:18:28 +0000 Subject: [PATCH 10/11] Updated quick start and building with ai intro page --- docs/building-with-ai.mdx | 2 +- docs/quick-start.mdx | 28 ++++++++++------------------ docs/snippets/step-cli-init.mdx | 15 +++++++++++---- 3 files changed, 22 insertions(+), 23 deletions(-) diff --git a/docs/building-with-ai.mdx b/docs/building-with-ai.mdx index 282273f9c5..ba8cd5bb47 100644 --- a/docs/building-with-ai.mdx +++ b/docs/building-with-ai.mdx @@ -15,7 +15,7 @@ We provide tools to help you build Trigger.dev projects with AI coding assistant ``` - Install pre-built prompts that teach AI assistants Trigger.dev best practices for writing tasks, configs, and more. + Portable instruction sets that teach any AI coding assistant Trigger.dev best practices for writing tasks, configs, and more. ```bash npx skills add triggerdotdev/skills diff --git a/docs/quick-start.mdx b/docs/quick-start.mdx index d6253bc269..375d225b67 100644 --- a/docs/quick-start.mdx +++ b/docs/quick-start.mdx @@ -8,29 +8,14 @@ import CliDevStep from '/snippets/step-cli-dev.mdx'; import CliRunTestStep from '/snippets/step-run-test.mdx'; import CliViewRunStep from '/snippets/step-view-run.mdx'; -In this guide we will: -1. Create a `trigger.config.ts` file and a `/trigger` directory with an example task. -2. Get you to run the task using the CLI. -3. Show you how to view the run logs for that task. + -You can either: - -- Use the [Trigger.dev Cloud](https://cloud.trigger.dev). -- Or [self-host](/open-source-self-hosting) the service. - - - - - -Once you've created an account, follow the steps in the app to: - -1. Complete your account details. -2. Create your first Organization and Project. +Sign up at [Trigger.dev Cloud](https://cloud.trigger.dev) (or [self-host](/open-source-self-hosting)). The onboarding flow will guide you through creating your first organization and project. @@ -43,11 +28,18 @@ Once you've created an account, follow the steps in the app to: ## Next steps - + + + Learn how to build Trigger.dev projects using AI coding assistants + Learn how to trigger tasks from your code. Tasks are the core of Trigger.dev. Learn what they are and how to write them. + + Guides and examples for triggering tasks from your code. + + diff --git a/docs/snippets/step-cli-init.mdx b/docs/snippets/step-cli-init.mdx index 265f3d9c89..84bb340dcf 100644 --- a/docs/snippets/step-cli-init.mdx +++ b/docs/snippets/step-cli-init.mdx @@ -20,12 +20,19 @@ yarn dlx trigger.dev@latest init + It will do a few things: -1. Log you into the CLI if you're not already logged in. -2. Create a `trigger.config.ts` file in the root of your project. -3. Ask where you'd like to create the `/trigger` directory. -4. Create the `/trigger` directory with an example task, `/trigger/example.[ts/js]`. + + Our [Trigger.dev MCP server](/mcp-introduction) gives your AI assistant direct access to Trigger.dev tools; search docs, trigger tasks, deploy projects, and monitor runs. We recommend installing it for the best developer experience. + + +1. Ask if you want to install the [Trigger.dev MCP server](/mcp-introduction) for your AI assistant. +2. Log you into the CLI if you're not already logged in. +3. Ask you to select your project. +4. Install the required SDK packages. +5. Ask where you'd like to create the `/trigger` directory and create it with an example task. +6. Create a `trigger.config.ts` file in the root of your project. Install the "Hello World" example task when prompted. We'll use this task to test the setup. From f6cecb0acdd8817909e0ed75d87a30ae35fb0487 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Thu, 29 Jan 2026 13:49:42 +0000 Subject: [PATCH 11/11] Fixes --- docs/mcp-introduction.mdx | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/mcp-introduction.mdx b/docs/mcp-introduction.mdx index 02a9157d94..257522d579 100644 --- a/docs/mcp-introduction.mdx +++ b/docs/mcp-introduction.mdx @@ -196,12 +196,10 @@ Each client has a slightly different config format. Copy the snippet for your cl ```json { - "amp": { - "mcpServers": { - "trigger": { - "command": "npx", - "args": ["trigger.dev@latest", "mcp"] - } + "amp.mcpServers": { + "trigger": { + "command": "npx", + "args": ["trigger.dev@latest", "mcp"] } } } @@ -231,7 +229,7 @@ Each client has a slightly different config format. Copy the snippet for your cl npx trigger.dev@latest install-mcp --client crush ``` - Or add this configuration to `~/.config/crush/crush.json` (user), `./crush.json` (project), or `./.crush.json` (local): + 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 {