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

[isshaddad]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 6589b45

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
trigger	🟢 Ready	View Preview	Apr 28, 2026, 1:17 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 4043586c-4efd-4549-bfd0-a05c0628d478

📥 Commits

Reviewing files that changed from the base of the PR and between dd92721 and 6589b45.

📒 Files selected for processing (1)

• docs/mcp-introduction.mdx

📜 Recent review details

🧰 Additional context used

📓 Path-based instructions (1)

docs/**/*.mdx

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from @trigger.dev/sdk in code examples (never from @trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences: typescript, bash, json

Files:

• docs/mcp-introduction.mdx

🧠 Learnings (6)

📓 Common learnings

Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:19.869Z
Learning: In the triggerdotdev/trigger.dev repository, docs PRs are often written as companions to implementation PRs (e.g., PR `#3200` documents features being added in PR `#3196`). When reviewing docs PRs, the documented features may exist in a companion/companion PR branch rather than main. Always check companion PRs referenced in the PR description before flagging missing implementations.

📚 Learning: 2026-03-02T12:43:34.140Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: packages/cli-v3/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:34.140Z
Learning: Applies to packages/cli-v3/src/mcp/**/* : Provide an MCP server implementation in `src/mcp/` for AI-assisted task development

Applied to files:

• docs/mcp-introduction.mdx

📚 Learning: 2026-03-02T12:43:02.539Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Applies to docs/**/*.mdx : Code examples must be complete and runnable where possible

Applied to files:

• docs/mcp-introduction.mdx

📚 Learning: 2026-03-25T15:29:25.889Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2026-03-25T15:29:25.889Z
Learning: Run `npx trigger.devlatest dev` to start the Trigger.dev development server

Applied to files:

• docs/mcp-introduction.mdx

📚 Learning: 2026-03-25T15:29:25.889Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2026-03-25T15:29:25.889Z
Learning: Run `npx trigger.devlatest init` to initialize a new Trigger.dev project

Applied to files:

• docs/mcp-introduction.mdx

📚 Learning: 2026-03-10T12:44:14.176Z

Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.

Applied to files:

• docs/mcp-introduction.mdx

🪛 LanguageTool

docs/mcp-introduction.mdx

[style] ~347-~347: Consider shortening or rephrasing this to strengthen your wording.
Context: ...r_task, cancel_run`) so the AI cannot make changes to your account. For example, to enable r...

(MAKE_CHANGES)

🔇 Additional comments (2)

docs/mcp-introduction.mdx (2)

343-349: Good clarification of install-time vs runtime flags.

This correctly prevents users from trying --readonly with install-mcp and explains where it actually belongs.

---

351-370: Runtime example is now complete and actionable.

The JSON snippet is fully copyable, and the follow-up note correctly handles client-specific argument shapes (including opencode).

---

Walkthrough

Removed --readonly from the install-mcp CLI options and deleted the install-mcp --readonly usage example. Added a "Runtime-only flags" section clarifying that --readonly applies to the generated MCP server configuration rather than the installer, and instructing users to add --readonly into the MCP config args after installation. Updated the JSON example to place runtime flags under mcpServers.trigger using command and an args array (including --readonly, --dev-only, and --project-ref), and advised applying the same pattern for other clients (args or command for opencode).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	No pull request description was provided; the required template sections (Testing, Changelog, Screenshots) are entirely missing.	Add a pull request description following the repository template, including Testing section with steps taken to verify the documentation changes and a Changelog section summarizing the update.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change—clarifying that --readonly is a runtime flag rather than an install-mcp option—which aligns with the documentation update shown in the summary.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/mcp-readonly-runtime-flag

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

Devin Review found 1 potential issue.

View 1 additional finding in Devin Review.