Skip to content

docs(mcp): clarify --readonly is a runtime flag, not an install-mcp o… #3459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
isshaddad wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(mcp): clarify --readonly is a runtime flag, not an install-mcp o… #3459

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd92721
docs(mcp): clarify --readonly is a runtime flag, not an install-mcp o…
isshaddad Apr 28, 2026
6589b45
coderabbit fixes
isshaddad Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions docs/mcp-introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,6 @@ The `install-mcp` command supports these options:
- `-p, --project-ref <project ref>` — Scope the MCP server to a specific project
- `-t, --tag <package tag>` — CLI package version to use (default: latest)
- `--dev-only` — Restrict to the dev environment only
- `--readonly` — Read-only mode. Hides write tools (`deploy`, `trigger_task`, `cancel_run`) so the AI cannot make changes to your account
- `--yolo` — Install into all supported clients automatically
- `--scope <scope>` — `user`, `project`, or `local`
- `--client <clients...>` — Install into specific client(s)
Expand Down Expand Up @@ -341,20 +340,34 @@ Restrict to dev environment for a specific project:
npx trigger.dev@latest install-mcp --dev-only --project-ref proj_abc123
```

Read-only mode (prevents AI from deploying or triggering tasks):
**Runtime-only flags**

```bash
npx trigger.dev@latest install-mcp --readonly
```
Some flags apply only to the running MCP server, not to `install-mcp`. Add these to the `args` array of the generated MCP config after installation:

- `--readonly` — Read-only mode. Hides write tools (`deploy`, `trigger_task`, `cancel_run`) so the AI cannot make changes to your account.
Comment thread
isshaddad marked this conversation as resolved.

To add these options to a manual config, append them to the `args` array:
For example, to enable read-only mode in Claude Code together with `--dev-only` and a project ref, edit `~/.claude.json` (user) or `.mcp.json` (project):

```json
{
"args": ["trigger.dev@latest", "mcp", "--dev-only", "--project-ref", "proj_abc123"]
"mcpServers": {
"trigger": {
"command": "npx",
"args": [
"trigger.dev@latest",
"mcp",
"--readonly",
"--dev-only",
"--project-ref",
"proj_abc123"
]
}
}
}
```
Comment thread
coderabbitai[bot] marked this conversation as resolved.

For other clients, use the config shape shown in the corresponding tab in [Client Configuration](#client-configuration) and append the same flags to that entry's `args` array (or to the `command` array, for opencode).

</Accordion>

## Getting Started
Expand Down
Loading