Skip to content

[Docs] Correct environment and MCP setup guidance #1412

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

Draft
roomote-community wants to merge 1 commit into
base: develop
Choose a base branch
from
+4 −4
Draft

[Docs] Correct environment and MCP setup guidance #1412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions apps/docs/environments/definition.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ starting long-running services.
| `cwd` | string | no | Alias for `working_dir`. |
| `timeout` | number | no | Seconds before the command is killed. Defaults to `600`. |
| `retries` | integer | no | Extra attempts for a failing command, with a 1-second delay. Use only for idempotent commands. Defaults to `0`. |
| `continue_on_error` | boolean | no | When `true`, setup continues even if this command fails. Defaults to `false`. |
| `continue_on_error` | boolean | no | Currently does not change repository setup behavior; failures are recorded as warnings and setup continues. |

@roomote-community roomote-community Bot Aug 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

continue_on_error still changes behavior for snapshot-environment setup: that path passes continueRepositoryCommandFailures: false, so the command executor honors the per-command flag and continues only when it is true. The new absolute wording tells snapshot authors the opposite. Please scope the warning-only behavior to standard task environment setup, or document the snapshot distinction.

| `detached` | boolean | no | Run in the background under supervision. Use for long-running servers. Defaults to `false`. |
| `logfile` | string | no | Path to capture stdout and stderr. Used with `detached: true`. |

Expand All @@ -211,8 +211,8 @@ Guidance:
before finishing" expectations in `agentInstructions` instead.
- use `detached: true` with a `logfile` for servers such as `pnpm dev`, so the
process keeps running and its output is debuggable.
- use `continue_on_error: true` only for helpful-but-optional steps. If the app
cannot run without a command, let it fail so the problem is visible.
- repository setup records failed commands as warnings and continues. Check the
setup status and logs before relying on the resulting environment.

## Services

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/integrations/custom-mcp-servers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ servers. Snippets that launch `mcp-remote` are converted to remote servers on
the upstream URL, which keeps credentials behind the Roomote proxy and
enables per-tool management.

Three kinds of servers are supported:
Four kinds of servers are supported:

| Kind | How it connects | Where credentials live |
| ----------------------- | -------------------------------------------------------------------------- | ----------------------------------------------- |
Expand Down
Loading