Skip to content

docs(clp-config): Add commented out default values to nullable mcp_server and presto in clp-config.yaml; Clarify configuration steps in the manuals. #1635

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
wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −17
Open

docs(clp-config): Add commented out default values to nullable mcp_server and presto in clp-config.yaml; Clarify configuration steps in the manuals. #1635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99079ac
docs(clp-config): Add commented out default values to nullable `mcp_s…
junhaoliao Nov 19, 2025
f9c97e1
Merge branch 'main' into nullable-config-docs
junhaoliao Nov 20, 2025
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
4 changes: 4 additions & 0 deletions components/package-template/src/etc/clp-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
# rate_limit: 1000
#
#mcp_server: null
## host: "localhost"
## port: 8000
#
## Where archives should be output to
#archive_output:
Expand Down Expand Up @@ -129,6 +131,8 @@
#
## Presto client config
#presto: null
## host: "localhost"
## port: 8889
#
## Location where other data (besides archives) are stored. It will be created if
## it doesn't exist.
Expand Down
17 changes: 5 additions & 12 deletions docs/src/user-docs/guides-mcp-server/index.md
View file
Open in desktop
Copy link
Member Author

@junhaoliao junhaoliao Nov 26, 2025

Choose a reason for hiding this comment

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

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

Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,9 @@ This guide assumes:

## Starting the MCP Server

1. Configure `clp-json` to run the MCP server by locating the `mcp_server` section in
`etc/clp-config.yaml`

```yaml
#mcp_server: null
```

then uncommenting it and specifying a `host` and `port`:
1. Configure `clp-json` to run the MCP server by uncommenting the `mcp_server` section in
`etc/clp-config.yaml` and specifying a `host` and `port`. Replace the default values if
necessary.

```yaml
mcp_server:
Expand All @@ -37,11 +32,9 @@ This guide assumes:
# other settings
```

Replace the default `host` and `port` shown above if necessary.

:::{note}
If you set `mcp_server: null` or leave the `mcp_server` section commented, the MCP server won't
be started with the rest of `clp-json`.
Setting `mcp_server: null` or leaving the section commented will prevent the MCP server from
starting with `clp-json`.
:::

2. Start `clp-json` and compress the logs you want to query by following the [clp-json
Expand Down
9 changes: 4 additions & 5 deletions docs/src/user-docs/guides-using-presto.md
View file
Open in desktop
Copy link
Member Author

@junhaoliao junhaoliao Nov 26, 2025

Choose a reason for hiding this comment

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

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

Copy link
Contributor

@davemarco davemarco Nov 26, 2025

Choose a reason for hiding this comment

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

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

Copy link
Member Author

@junhaoliao junhaoliao Nov 28, 2025

Choose a reason for hiding this comment

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

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

Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,13 @@ Using Presto with CLP requires:
retention_period: null
```

* 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
values if necessary.

```yaml
presto:
host: "<ip-address>"
port: <port>
host: "localhost"
port: 8889
```

:::{note}
Expand Down
Loading