Skip to content

Commit 7d65aa9

Browse files
committed
Describe the MCP server feature in the readme
1 parent 603c903 commit 7d65aa9

File tree

3 files changed

+38
-1
lines changed

3 files changed

+38
-1
lines changed

.cursor/mcp.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"mcpServers": {
3+
"trigger.dev": {
4+
"url": "http://localhost:3333/sse"
5+
}
6+
}
7+
}

packages/cli-v3/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,37 @@ Trigger.dev is an open source platform that makes it easy to create event-driven
1919
| [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles. |
2020
| [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
2121

22+
## MCP Server
23+
24+
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that allows you to provide custom tools
25+
to agentic LLM clients, like [Claude for Desktop](https://docs.anthropic.com/en/docs/claude-for-desktop/overview), [Cursor](https://www.cursor.com/), [Windsurf](https://windsurf.com/), etc...
26+
27+
The Trigger.dev CLI can expose an MCP server and enable you interact with Trigger.dev in agentic LLM workflows. For example, you can use
28+
it to trigger tasks via natural language, view task runs, view logs, debug issues with task runs, etc...
29+
30+
### Starting the Trigger.dev MCP Server
31+
32+
To start the Trigger.dev MCP server, simply pass the `--mcp` flag to the `dev` command:
33+
34+
```bash
35+
trigger dev --mcp
36+
```
37+
38+
By default it runs on port `3333`. You can change this by passing the `--mcp-port` flag:
39+
40+
```bash
41+
trigger dev --mcp --mcp-port 3334
42+
```
43+
44+
### Configuring your MCP client
45+
46+
This depends on what tool you are using. For Cursor, the configuration is in the [.cursor/mcp.json](../../.cursor/mcp.json) file
47+
and should be good to go as long as you use the default MCP server port.
48+
49+
Check out [Cursor's docs](https://docs.cursor.com/context/model-context-protocol) for further details.
50+
51+
Tip: try out [Cursor's YOLO mode](https://docs.cursor.com/context/model-context-protocol#yolo-mode) for a seamless experience :D
52+
2253
## Support
2354

2455
If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.

packages/cli-v3/src/commands/dev.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ export function configureDevCommand(program: Command) {
5050
"--keep-tmp-files",
5151
"Keep temporary files after the dev session ends, helpful for debugging"
5252
)
53-
// TODO: add a more detailed description, maybe a pointer to the docs on how to use MCP
5453
.option("--mcp", "Start the MCP server")
5554
.option("--mcp-port", "The port to run the MCP server on", "3333")
5655
).action(async (options) => {

0 commit comments

Comments
 (0)