docs(clp-config): Add commented out default values to nullable `mcp_server` and `presto` in `clp-config.yaml`; Clarify configuration steps in the manuals. by junhaoliao · Pull Request #1635 · y-scope/clp

junhaoliao · 2025-11-19T22:50:36Z

Description

This PR updates configuration comments and user documentation for both the MCP server and Presto:

Adds explicit host and port example fields (commented out) to the mcp_server and presto sections in clp-config.yaml.
Removes outdated instructions and aligns wording across guides for consistency.
- Simplifies and clarifies the MCP server setup instructions in guides-mcp-server, emphasizing uncommenting the block and replacing defaults when needed.
- Updates the Presto usage guide to include concrete default example values (localhost, 8889) and clarifies that users may replace them if needed.

These changes improve clarity for users configuring CLP components.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

task docs:serve and inspected the docs.

Summary by CodeRabbit

Documentation
- Clarified MCP server setup to require an explicit mcp_server block with host/port and noted that commenting/nulling it prevents the MCP server from starting.
- Revised Presto instructions to emphasize using actual cluster host/port and show concrete default values.
- Updated configuration templates to include commented host/port placeholders for MCP and Presto.

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1212888467152957
- https://app.asana.com/0/0/1212888468767811

…erver` and `presto` in `clp-config.yaml`; Clarify configuration steps in the manuals.

coderabbitai · 2025-11-19T22:50:42Z

Walkthrough

Documentation and configuration templates were updated to provide explicit MCP server and Presto client host/port examples; guides now show direct configuration entries and clarify behavior when the mcp_server section is commented or null. Template files add commented host/port placeholders for mcp_server and presto.

Changes

Cohort / File(s)	Summary
MCP Server Guide `docs/src/user-docs/guides-mcp-server/index.md`	Reworked guidance to show an explicit `mcp_server` block with `host` and `port` set directly; clarifies that commenting or setting `mcp_server` to `null` prevents the MCP server from starting with clp-json.
Presto Guide `docs/src/user-docs/guides-using-presto.md`	Rewrote instructions to instruct users to update presto host/port with cluster values; example YAML now shows concrete default values (e.g., `localhost`, `8889`) and removes cross-reference to other sections.
Config templates `components/package-template/src/etc/clp-config.template.json.yaml`, `components/package-template/src/etc/clp-config.template.text.yaml`	Added commented example host/port entries for `mcp_server` and `presto` client config in template files (e.g., `host: "localhost"`, `port: 8000` for mcp_server; presto host/port placeholders/defaults). No functional code changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately captures the main changes: adding commented default values to config templates and clarifying configuration steps in documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into `main`

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

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch nullable-config-docs

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

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

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

junhaoliao · 2025-11-26T12:21:37Z

docs/src/user-docs/guides-mcp-server/index.md

@rishikeshdevsot may i get your approval for the modifications in this docs if they look good to you?

junhaoliao · 2025-11-26T12:22:28Z

docs/src/user-docs/guides-using-presto.md

@davemarco may i get your approval for the modifications in this docs if they look good to you?

I think haiqi originally did not want to put the "default" port since there is no error when starting the package if the port is incorrect. Like he wanted to force the user to input their specific port

hmm.. even if we ask users to provide a port, if we don't do any checks (i guess we really can't), there is no guarantee that the port is valid?

fwiw, i believe providing a default helps avoid collision with ports of other services in the CLP package / other well-known ports

@davemarco / @kirkrodrigues could you check if the latest proposal would address those concerns of users using non-standard ports

junhaoliao

@davemarco / @kirkrodrigues could you check if the latest proposal would address those concerns of users using non-standard ports

junhaoliao · 2026-02-17T01:57:04Z

docs/src/user-docs/guides-using-presto.md

-    * Update the `presto` key with the host and port of the Presto cluster. If you follow the
-      [Setting up Presto](#setting-up-presto) section, the host is `localhost` and the port is
-      `8889`.
+    * Update the `presto` key with the `host` and `port` of the Presto cluster. Replace the default


Suggested change

* Update the `presto` key with the `host` and `port` of the Presto cluster. Replace the default

* Update the `presto` key with the `host` and `port` of the Presto coordinator. Replace the default

junhaoliao · 2026-02-17T01:57:14Z

docs/src/user-docs/guides-using-presto.md

-        host: "<ip-address>"
-        port: <port>
+        host: "localhost"
+        port: 8889


Suggested change

port: 8889

host: <presto-coordinator-ip> # default: "localhost"

port: <presto-coordinator-port> # default: 8889

junhaoliao · 2026-02-17T01:58:33Z

components/package-template/src/etc/clp-config.yaml

+##  host: "localhost"
+##  port: 8889


Suggested change

## host: "localhost"

## port: 8889

## host: <presto-coordinator-ip> # default: "localhost"

## port: <presto-coordinator-port> # default: 8889

junhaoliao · 2026-02-17T01:59:24Z

docs/src/user-docs/guides-using-presto.md

@davemarco / @kirkrodrigues could you check if the latest proposal would address those concerns of users using non-standard ports

…rity

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

components/package-template/src/etc/clp-config.template.json.yaml (1)
107-107: ⚠️ Potential issue | 🟡 Minor

Missing mcp_server host/port comments in this template.

The PR objective states that commented example fields for host and port should be added to both the mcp_server and presto sections. The text.yaml template has them (lines 90–91), but this file does not. This looks like an oversight.
Proposed fix
 `#mcp_server`: null
+##  host: "localhost"
+##  port: 8000
 #
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@components/package-template/src/etc/clp-config.template.json.yaml` at line
107, The template is missing commented example host/port fields for the
mcp_server and presto sections; update the clp-config.template.json.yaml to
mirror the text.yaml examples by adding commented lines like "# host:
example.com" and "# port: 1234" under both the mcp_server and presto keys
(ensure comments are YAML-style and placed immediately beneath the mcp_server
and presto entries so they serve as clear usage examples).

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@components/package-template/src/etc/clp-config.template.json.yaml`:
- Line 107: The template is missing commented example host/port fields for the
mcp_server and presto sections; update the clp-config.template.json.yaml to
mirror the text.yaml examples by adding commented lines like "# host:
example.com" and "# port: 1234" under both the mcp_server and presto keys
(ensure comments are YAML-style and placed immediately beneath the mcp_server
and presto entries so they serve as clear usage examples).

components/package-template/src/etc/clp-config.template.json.yaml

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@components/package-template/src/etc/clp-config.template.json.yaml`:
- Around line 160-162: The presto section uses angle-bracket placeholders that
are inconsistent with the mcp_server section and can create invalid YAML; change
the presto block (keys: presto.host and presto.port) to show the actual default
values (e.g., "localhost" and 8889) as the values (not angle-bracket tokens) and
keep a short inline comment indicating they can be replaced, mirroring how
mcp_server is represented so uncommenting the block won't introduce invalid
tokens.

coderabbitai · 2026-02-17T06:09:14Z

components/package-template/src/etc/clp-config.template.json.yaml

 #presto: null
+##  host: <presto-coordinator-ip>  # default: "localhost"
+##  port: <presto-coordinator-port>  # default: 8889


🧹 Nitpick | 🔵 Trivial

Inconsistent placeholder style compared to mcp_server section.

Lines 108–109 for mcp_server show actual default values ("localhost", 8000), while here angle-bracket placeholders are used with defaults relegated to trailing comments. Consider using the same pattern for both sections — i.e., showing the actual defaults directly and noting they can be replaced:

Suggested diff

`#presto`: null -## host: <presto-coordinator-ip> # default: "localhost" -## port: <presto-coordinator-port> # default: 8889 +## host: "localhost" +## port: 8889

This would also avoid leaving invalid YAML tokens (<...>) that would cause a parse error if a user uncomments the block without replacing them.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

#presto: null

## host: <presto-coordinator-ip> # default: "localhost"

## port: <presto-coordinator-port> # default: 8889

`#presto`: null

## host: "localhost"

## port: 8889

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed. In `@components/package-template/src/etc/clp-config.template.json.yaml` around lines 160 - 162, The presto section uses angle-bracket placeholders that are inconsistent with the mcp_server section and can create invalid YAML; change the presto block (keys: presto.host and presto.port) to show the actual default values (e.g., "localhost" and 8889) as the values (not angle-bracket tokens) and keep a short inline comment indicating they can be replaced, mirroring how mcp_server is represented so uncommenting the block won't introduce invalid tokens.

docs(clp-config): Add commented out default values to nullable `mcp_s…

99079ac

…erver` and `presto` in `clp-config.yaml`; Clarify configuration steps in the manuals.

junhaoliao requested review from 20001020ycx, davemarco and rishikeshdevsot November 19, 2025 22:59

junhaoliao marked this pull request as ready for review November 19, 2025 22:59

junhaoliao requested a review from a team as a code owner November 19, 2025 22:59

Merge branch 'main' into nullable-config-docs

f9c97e1

junhaoliao commented Nov 26, 2025

View reviewed changes

junhaoliao modified the milestones: Backlog, February 2026 Jan 19, 2026

junhaoliao commented Feb 17, 2026

View reviewed changes

junhaoliao and others added 3 commits February 16, 2026 21:06

Merge branch 'main' into nullable-config-docs

a01fc32

docs(config): Update Presto client configuration placeholders for cla…

d9eaff0

…rity

Merge branch 'main' into nullable-config-docs

f6ea242

coderabbitai bot reviewed Feb 17, 2026

View reviewed changes

junhaoliao commented Feb 17, 2026

View reviewed changes

components/package-template/src/etc/clp-config.template.json.yaml Show resolved Hide resolved

add mcp values to json.yaml as well

c85afa3

coderabbitai bot reviewed Feb 17, 2026

View reviewed changes

	* Update the `presto` key with the `host` and `port` of the Presto cluster. Replace the default
	* Update the `presto` key with the `host` and `port` of the Presto coordinator. Replace the default

	port: 8889
	host: <presto-coordinator-ip> # default: "localhost"
	port: <presto-coordinator-port> # default: 8889

Conversation

junhaoliao commented Nov 19, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junhaoliao left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junhaoliao Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

junhaoliao commented Nov 19, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 19, 2025 •

edited

Loading

junhaoliao Feb 17, 2026 •

edited

Loading