Skip to content

Commit 7424e1a

Browse files
committed
Added docs links and improved about
1 parent e9d0b25 commit 7424e1a

File tree

2 files changed

+25
-33
lines changed

2 files changed

+25
-33
lines changed

packages/cli-v3/README.md

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ A CLI that allows you to create, run locally and deploy Trigger.dev background t
44

55
Note: this only works with Trigger.dev v3 projects and later. For older projects use the [@trigger.dev/cli](https://www.npmjs.com/package/@trigger.dev/cli) package.
66

7-
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
7+
## About Trigger.dev
8+
9+
Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling.
810

911
## Commands
1012

@@ -22,36 +24,9 @@ Trigger.dev is an open source platform that makes it easy to create event-driven
2224
| [switch](https://trigger.dev/docs/cli-switch) | Switch between CLI profiles. |
2325
| [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
2426

25-
## MCP Server
26-
27-
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that allows you to provide custom tools
28-
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...
29-
30-
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
31-
it to trigger tasks via natural language, view task runs, view logs, debug issues with task runs, etc...
32-
33-
### Starting the Trigger.dev MCP Server
34-
35-
To start the Trigger.dev MCP server, simply pass the `--mcp` flag to the `dev` command:
36-
37-
```bash
38-
trigger dev --mcp
39-
```
40-
41-
By default it runs on port `3333`. You can change this by passing the `--mcp-port` flag:
42-
43-
```bash
44-
trigger dev --mcp --mcp-port 3334
45-
```
46-
47-
### Configuring your MCP client
48-
49-
This depends on what tool you are using. For Cursor, the configuration is in the [.cursor/mcp.json](../../.cursor/mcp.json) file
50-
and should be good to go as long as you use the default MCP server port.
51-
52-
Check out [Cursor's docs](https://docs.cursor.com/context/model-context-protocol) for further details.
27+
## Documentation
5328

54-
Tip: try out [Cursor's YOLO mode](https://docs.cursor.com/context/model-context-protocol#yolo-mode) for a seamless experience :D
29+
For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction).
5530

5631
## Support
5732

packages/trigger-sdk/README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,32 @@
1818

1919
# Official TypeScript SDK for Trigger.dev
2020

21-
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project.
21+
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your projects.
2222

2323
## About Trigger.dev
2424

25-
Trigger.dev is a platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling.
25+
Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling.
26+
27+
## Core features
28+
29+
- Task creation and execution
30+
- CLI for development and deployment
31+
- Build system with extensions
32+
- Management API for runs, schedules, and environment variables
33+
34+
## Key Components:
35+
36+
- Tasks: Background jobs written in TypeScript/JavaScript
37+
- CLI: Commands for login, init, dev, deploy
38+
- Build Extensions: Customize builds (Prisma, Python, FFmpeg, etc.)
39+
- Management API: Programmatic control over runs and resources
2640

2741
## Getting started
2842

29-
The quickest way to get started is to create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes.
43+
There are two ways to get started:
44+
45+
1. Create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes.
46+
2. [Manual setup](https://trigger.dev/docs/manual-setup) in your existing project.
3047

3148
## SDK usage
3249

0 commit comments

Comments
 (0)