Skip to content

Commit 6458601

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

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

‎docs/mcp-introduction.mdx‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,17 @@ npx trigger.dev@latest install-mcp
2727
```
2828

2929
This command will guide you through:
30+
3031
1. Selecting which MCP clients to configure
3132
2. Choosing installation scope (user, project, or local)
3233
3. Automatically configuring the selected clients
3334

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-
4235
## Command Line Options
4336

4437
The `install-mcp` command supports the following options:
4538

4639
### Core Options
40+
4741
- `-p, --project-ref <project ref>` - Scope the MCP server to a specific Trigger.dev project by providing its project ref
4842
- `-t, --tag <package tag>` - The version of the trigger.dev CLI package to use for the MCP server (default: latest or v4-beta)
4943
- `--dev-only` - Restrict the MCP server to the dev environment only
@@ -52,23 +46,27 @@ The `install-mcp` command supports the following options:
5246
- `--client <clients...>` - Choose specific client(s) to install into
5347

5448
### Configuration Options
49+
5550
- `--log-file <log file>` - Configure the MCP server to write logs to a file
5651
- `-a, --api-url <value>` - Configure a custom Trigger.dev API URL
5752
- `-l, --log-level <level>` - Set CLI log level (debug, info, log, warn, error, none)
5853

5954
### Examples
6055

6156
Install for all supported clients:
57+
6258
```bash
6359
npx trigger.dev@latest install-mcp --yolo
6460
```
6561

6662
Install for specific clients:
63+
6764
```bash
6865
npx trigger.dev@latest install-mcp --client claude-code cursor --scope user
6966
```
7067

7168
Install with development environment restriction:
69+
7270
```bash
7371
npx trigger.dev@latest install-mcp --dev-only --project-ref proj_abc123
7472
```
@@ -77,19 +75,19 @@ npx trigger.dev@latest install-mcp --dev-only --project-ref proj_abc123
7775

7876
The Trigger.dev MCP Server supports the following clients:
7977

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/) |
78+
| Client | Configuration File | Documentation |
79+
| -------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
80+
| **Claude Code** | `~/.claude.json` or `./.mcp.json` | [Claude Code MCP Docs](https://docs.anthropic.com/en/docs/claude-code/mcp) |
81+
| **Cursor** | `~/.cursor/mcp.json` or `./.cursor/mcp.json` | [Cursor MCP Docs](https://docs.cursor.com/features/mcp) |
82+
| **VSCode** | `~/Library/Application Support/Code/User/mcp.json` or `./.vscode/mcp.json` | [VSCode MCP Docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) |
83+
| **Zed** | `~/.config/zed/settings.json` | [Zed Context Servers Docs](https://zed.dev/docs/context-servers) |
84+
| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` | [Windsurf MCP Docs](https://docs.codeium.com/windsurf/mcp) |
85+
| **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) |
86+
| **Charm Crush** | `~/.config/crush/crush.json` or `./crush.json` | [Charm MCP Docs](https://github.com/charmbracelet/mcp) |
87+
| **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) |
88+
| **OpenAI Codex CLI** | `~/.codex/config.toml` | See OpenAI Codex CLI documentation for MCP configuration |
89+
| **Sourcegraph AMP** | `~/.config/amp/settings.json` | [Sourcegraph AMP MCP Docs](https://docs.sourcegraph.com/amp/mcp) |
90+
| **opencode** | `~/.config/opencode/opencode.json` or `./opencode.json` | [opencode MCP Docs](https://opencode.ai/docs/mcp-servers/) |
9391

9492
## Manual Configuration
9593

@@ -102,6 +100,7 @@ If your client isn't directly supported by the installer, you can configure it m
102100
**Arguments:** `["trigger.dev@latest", "mcp"]`
103101

104102
### Example JSON Configuration
103+
105104
```json
106105
{
107106
"mcpServers": {
@@ -114,13 +113,15 @@ If your client isn't directly supported by the installer, you can configure it m
114113
```
115114

116115
### Example TOML Configuration (for Codex CLI)
116+
117117
```toml
118118
[mcp_servers.trigger]
119119
command = "npx"
120120
args = ["trigger.dev@latest", "mcp"]
121121
```
122122

123123
### Additional Options
124+
124125
You can add these optional arguments to customize the server behavior:
125126

126127
- `--log-file <path>` - Log to a specific file
@@ -131,6 +132,7 @@ You can add these optional arguments to customize the server behavior:
131132
## Environment-Specific Configuration
132133

133134
### Development Only
135+
134136
To restrict the MCP server to only work with the development environment:
135137

136138
```json
@@ -145,6 +147,7 @@ To restrict the MCP server to only work with the development environment:
145147
```
146148

147149
### Project-Scoped
150+
148151
To scope the server to a specific project:
149152

150153
```json
@@ -175,6 +178,4 @@ Once installed, you can start using the MCP server by asking your AI assistant q
175178

176179
## Next Steps
177180

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
181+
- [Explore available MCP tools](/mcp-tools)

0 commit comments

Comments
 (0)