docs: Add user guide for CLP MCP server.#1456
Conversation
WalkthroughAdds a new MCP Server documentation section: a main guide and three agent-specific guides (Claude Desktop, Cursor, VSCode) that explain prerequisites, example config snippets, enabling and starting Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant User
participant Agent as "Claude / Cursor / VSCode"
participant MCP as "clp-json (MCP Server)"
rect rgb(230,247,255)
Note over User,Agent: Configure server & agents
User->>MCP: Enable `mcp_server` in `etc/clp-config.yml` (host:port)
User->>MCP: Start `clp-json` with MCP enabled
User->>Agent: Add MCP server entry (host:port / `mcpServers` JSON)
end
rect rgb(243,255,230)
Note over Agent,MCP: Runtime HTTP interactions
Agent->>MCP: HTTP /discover or /tools
MCP-->>Agent: Tools list / status
Agent->>MCP: Tool execution or search request
MCP-->>Agent: Results / responses
end
rect rgb(255,243,230)
Note over Agent,User: Verification
Agent->>User: Shows MCP server under "Search and Tools"
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (4)📚 Learning: 2025-08-15T21:48:46.674ZApplied to files:
📚 Learning: 2025-08-17T16:19:24.478ZApplied to files:
📚 Learning: 2025-10-02T15:48:58.961ZApplied to files:
📚 Learning: 2025-10-20T20:19:40.504ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (2)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/src/user-docs/guides-mcp-server/claude-developer-menu.pngis excluded by!**/*.pngdocs/src/user-docs/guides-mcp-server/claude-settings.pngis excluded by!**/*.png
📒 Files selected for processing (5)
docs/src/user-docs/guides-mcp-server/index.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-cursor.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-vscode.md(1 hunks)docs/src/user-docs/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/user-docs/guides-mcp-server/mcp-cursor.md
[uncategorized] ~19-~19: Possible missing preposition found.
Context: ...rver). 3. Restart Cursor. This applies the new configuration. 4. Enable and use th...
(AI_HYDRA_LEO_MISSING_TO)
🔇 Additional comments (10)
docs/src/user-docs/guides-mcp-server/mcp-cursor.md (1)
19-20: Steps 3 and 4 look good.Clear instructions for restarting the application and referencing official documentation.
docs/src/user-docs/guides-mcp-server/mcp-vscode.md (2)
5-16: JSON configuration is correctly formatted.The configuration snippet is syntactically valid and follows VSCode's expected structure. URL placeholders are properly formatted.
18-19: Usage instructions and links are clear.Step 3 provides direct reference to official VSCode documentation for using MCP tools in agent mode.
docs/src/user-docs/guides-mcp-server/index.md (3)
6-10: Prerequisites section is clear and complete.Both prerequisites are relevant and appropriately linked to related documentation.
12-21: Configuration and startup instructions are clear.YAML configuration snippet is properly formatted, default values are stated, and the guide correctly explains that starting clp-json will run the MCP server on the configured host and port.
23-62: Agent connection section is well-structured and comprehensive.The grid layout with linked cards provides intuitive navigation to agent-specific guides. The timezone caution is important and well-placed. The toctree properly references all agent guides for documentation generation.
docs/src/user-docs/index.md (1)
62-65: New MCP server guide is properly integrated into documentation index.The addition of
guides-mcp-server/indexto the Guides toctree is positioned correctly within the existing structure and will enable proper documentation generation and navigation.docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md (3)
5-7: Prerequisites are clearly stated and properly linked.The two prerequisites (Node.js >= 16 and mcp-remote package) are appropriate and relevant. The mcp-remote package reference at the end of the file is properly linked to the npm package page.
12-19: Verify image files are present and accessible.The guide references two image files (
claude-settings.pngandclaude-developer-menu.png). Ensure these files exist in the same directory and that image paths are correct for the documentation build system.
21-43: MCP server configuration and setup steps are correct and complete.JSON configuration is syntactically valid with properly formatted URL placeholders. The npx command with mcp-remote arguments is correct. Reference to mcp-remote documentation for additional options provides users with self-service resources. Final steps for saving and restarting are clear.
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (1)
docs/src/user-docs/guides-mcp-server/mcp-cursor.md (1)
7-16: Malformed URL in JSON configuration snippet.This is a duplicate of a previous review comment. The JSON snippet contains a malformed URL placeholder: the closing angle bracket is missing from the port placeholder, making the configuration invalid. Additionally, the code block is missing a language identifier and contains hard tabs.
Apply this diff to fix the URL, add the language identifier, replace hard tabs with spaces, and add blank lines around the fence:
+ ```json { "mcpServers": { "clp-mcp-server": { - "url": "http://<host>:<port/mcp", - "type": "http" - } + "url": "http://<host>:<port>/mcp", + "type": "http" + } } }
</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: ASSERTIVE **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between d61c893da7b78f63167085161545efe34e0d6773 and 51e6cd055df74bcc44a75136429a10cbb2faf232. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/src/user-docs/guides-mcp-server/mcp-cursor.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>docs/src/user-docs/guides-mcp-server/mcp-cursor.md</summary> [uncategorized] ~19-~19: Possible missing preposition found. Context: ...rver). 3. Restart Cursor. This applies the new configuration. 4. Enable and use th... (AI_HYDRA_LEO_MISSING_TO) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>docs/src/user-docs/guides-mcp-server/mcp-cursor.md</summary> 1-1: Headings should be surrounded by blank lines Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) --- 4-4: Headings should be surrounded by blank lines Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) --- 5-5: Trailing spaces Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) --- 7-7: Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 7-7: Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 11-11: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 12-12: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 13-13: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 16-16: Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 19-19: Ordered list item prefix Expected: 1; Actual: 3; Style: 1/2/3 (MD029, ol-prefix) --- 20-20: Ordered list item prefix Expected: 2; Actual: 4; Style: 1/2/3 (MD029, ol-prefix) --- 20-20: Files should end with a single newline character (MD047, single-trailing-newline) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)</summary> * GitHub Check: antlr-code-committed (macos-15) * GitHub Check: build (ubuntu-24.04) * GitHub Check: rust-checks (ubuntu-24.04) * GitHub Check: rust-checks (ubuntu-22.04) </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| 3. Restart Cursor. This applies the new configuration. | ||
| 4. Enable and use the MCP server's tools as described in the [official Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-in-chat). No newline at end of file |
There was a problem hiding this comment.
Fix ordered list numbering and add missing newline at end of file.
The ordered list items are numbered 3 and 4, but they should be numbered 1 and 2 within a new list, or the previous list should be properly closed. Additionally, the file is missing a final newline character.
Apply this diff to correct the numbering and add the trailing newline:
-3. Restart Cursor. This applies the new configuration.
-4. Enable and use the MCP server's tools as described in the [official Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-in-chat).
+
+3. Restart Cursor. This applies the new configuration.
+4. Enable and use the MCP server's tools as described in the [official Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-in-chat).Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~19-~19: Possible missing preposition found.
Context: ...rver). 3. Restart Cursor. This applies the new configuration. 4. Enable and use th...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.18.1)
19-19: Ordered list item prefix
Expected: 1; Actual: 3; Style: 1/2/3
(MD029, ol-prefix)
20-20: Ordered list item prefix
Expected: 2; Actual: 4; Style: 1/2/3
(MD029, ol-prefix)
20-20: Files should end with a single newline character
(MD047, single-trailing-newline)
🤖 Prompt for AI Agents
In docs/src/user-docs/guides-mcp-server/mcp-cursor.md around lines 19-20 the
ordered list shows items numbered "3." and "4." but they should start a new list
as "1." and "2." (or properly close the previous list before continuing); update
the numbers to 1 and 2 (or insert a blank line to terminate the prior list and
start a fresh ordered list) and ensure the file ends with a trailing newline
character so there's a final blank line at EOF.
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-cursor.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-vscode.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/user-docs/guides-mcp-server/mcp-cursor.md
[uncategorized] ~21-~21: Possible missing preposition found.
Context: ...rver). 3. Restart Cursor. This applies the new configuration. 4. Enable and use th...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.18.1)
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md
9-9: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
16-16: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
19-19: Ordered list item prefix
Expected: 1; Actual: 3; Style: 1/1/1
(MD029, ol-prefix)
docs/src/user-docs/guides-mcp-server/mcp-cursor.md
9-9: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
16-16: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
19-19: Ordered list item prefix
Expected: 1; Actual: 3; Style: 1/1/1
(MD029, ol-prefix)
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
docs/src/user-docs/guides-mcp-server/index.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-cursor.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-vscode.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/user-docs/guides-mcp-server/mcp-cursor.md
[uncategorized] ~23-~23: Possible missing preposition found.
Context: ...rver). 3. Restart Cursor. This applies the new configuration. 4. Enable and use th...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.18.1)
docs/src/user-docs/guides-mcp-server/mcp-vscode.md
21-21: Ordered list item prefix
Expected: 1; Actual: 3; Style: 1/1/1
(MD029, ol-prefix)
🔇 Additional comments (4)
docs/src/user-docs/guides-mcp-server/mcp-cursor.md (1)
1-24: All previous issues resolved, documentation is clear and well-formatted.Markdown linting issues previously flagged have been properly addressed. Code block is correctly formatted with JSON language specifier and appropriate blank-line spacing. Cross-references to the index guide are correct. Structure and content look good.
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md (1)
1-49: Well-structured guide with clear prerequisites and properly formatted code examples.The guide is well organized, prerequisites are explicit, and the mcp-remote package reference is current. Code block formatting with JSON syntax highlighting is correct.
docs/src/user-docs/guides-mcp-server/index.md (1)
1-64: Overall structure and content is excellent; minor style improvements suggested above.The MCP server documentation is well-organized with clear prerequisites, step-by-step configuration, and helpful cross-references. The grid layout for connecting different agents is effective. The caution about UTC timestamps is important context. The three flagged items are optional style improvements for consistency and professional polish.
docs/src/user-docs/guides-mcp-server/mcp-vscode.md (1)
8-21: Resolve ordered list numbering issue (MD029): indent code block and explanation text to maintain list continuity.Markdownlint flags line 21 as having incorrect list numbering. The issue is that the code block (lines 10–17) and explanatory text (line 19) are not indented, which breaks the ordered list started on lines 7–8. When item 3 appears on line 21, the linter expects a fresh list starting at 1.
To fix, indent the code block and explanation text by 4 spaces so they remain part of item 2, maintaining the list flow (1, 2, 3, 4).
Apply this diff to resolve the list structure:
2. The json configuration for CLP's MCP should be added to the `servers` object: -```json +" ```json -"servers": { - "clp-mcp-server": { - "type": "http", - "url": "http://<host>:<port>/mcp" - } -} -``` +" "servers": { +" "clp-mcp-server": { +" "type": "http", +" "url": "http://<host>:<port>/mcp" +" } +" } +" ``` -The `host` and `port` values should match the hostname and port number where the MCP server is running, as specified during [configuration](../guides-mcp-server/index.md#starting-mcp-server). + The `host` and `port` values should match the hostname and port number where the MCP server is running, as specified during [configuration](../guides-mcp-server/index.md#starting-mcp-server).⛔ Skipped due to learnings
Learnt from: quinntaylormitchell PR: y-scope/clp#1154 File: docs/src/user-guide/guides-using-presto.md:53-55 Timestamp: 2025-08-05T16:13:24.482Z Learning: In the CLP project's documentation system, numbered list items with line breaks do not require additional indentation for continuation lines to remain part of the list item - the markdown parser correctly keeps wrapped content within the numbered list item even without strict indentation.
20001020ycx
left a comment
There was a problem hiding this comment.
Clear documentation, left a minor comment, the rest LGTM
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/src/user-docs/guides-mcp-server/index.md (1)
54-55: Use correct terminology: "time zone" (two words) instead of "timezone".The caution block uses "timezone" (one word) in three places, but the standard English term is "time zone" (two words). Additionally, the phrasing can be tightened by removing redundant wording.
Apply this diff to correct the terminology and tighten the phrasing:
:::{caution} -CLP currently doesn't store timezone information in the compressed logs. All timestamps in the logs being compressed are assumed to be in UTC. So you should specify the timezone of the compressed logs to the agent if they are not UTC. -Support for encoding timezone information in the compressed logs will be available in a future release. +CLP currently doesn't store time zone information in the compressed logs. All timestamps in the logs being compressed are assumed to be in UTC. If the logs are in a different time zone, specify it to the agent. +Support for encoding time zone information in the compressed logs will be available in a future release. :::
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-docs/guides-mcp-server/index.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/src/user-docs/guides-mcp-server/index.md
1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
12-12: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
25-25: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/src/user-docs/guides-mcp-server/mcp-vscode.md (1)
9-30: Remove trailing spaces throughout the file to pass markdown linting.Multiple lines contain trailing spaces that violate the MD009 linting rule. The spaces appear at the end of lines 9, 10, 23, 24, 27, 28, and 29, breaking markdown consistency.
Apply this diff to remove all trailing spaces:
-1. Follow the +1. Follow the -[official VSCode guide](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) +[official VSCode guide](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) to add an MCP server to VSCode. 2. The json configuration for CLP's MCP should be added to the `servers` object: ```json "servers": { "clp-mcp-server": { "type": "http", "url": "http://<host>:<port>/mcp" } } ``` - The `host` and `port` values should match the hostname and - port number where the MCP server is running, as + The `host` and `port` values should match the hostname and + port number where the MCP server is running, as specified during [configuration](../guides-mcp-server/index.md#starting-the-mcp-server). -3. Once you have added the MCP server, you can -follow -[this section](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_use-mcp-tools-in-agent-mode) +3. Once you have added the MCP server, you can +follow +[this section](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_use-mcp-tools-in-agent-mode) to use the CLP MCP tools in agent mode.docs/src/user-docs/guides-mcp-server/mcp-cursor.md (1)
8-28: Remove trailing spaces throughout the file to pass markdown linting.Multiple lines contain trailing spaces that violate the MD009 linting rule (lines 8, 23, 24, 27). These must be removed to pass the linter.
Apply this diff to remove all trailing spaces:
-1. Follow the [official Cursor guide](https://cursor.com/docs/context/mcp) +1. Follow the [official Cursor guide](https://cursor.com/docs/context/mcp) to add a Remote MCP Server using `mcp.json`. 2. Add the following `clp-mcp-server` config to the `mcpServers` object and save the file. ```json { "mcpServers": { "clp-mcp-server": { "url": "http://<host>:<port>/mcp", "type": "http" } } } ``` - The `host` and `port` values should match the hostname and port number - where the MCP server is running, as specified + The `host` and `port` values should match the hostname and port number + where the MCP server is running, as specified during [configuration](../guides-mcp-server/index.md#starting-the-mcp-server). -3. Enable and use the MCP server's tools as described in +3. Enable and use the MCP server's tools as described in the [official Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-in-chat).docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md (1)
19-56: Remove trailing spaces throughout the file to pass markdown linting.Multiple lines contain trailing spaces that violate the MD009 linting rule. Lines 19, 26, 47, 48, 49, 53, and 55 all have trailing spaces that must be removed.
Apply this diff to remove all trailing spaces:
-2. Navigate to the "Developer" tab in the sidebar. Click on "Edit Config" to edit +2. Navigate to the "Developer" tab in the sidebar. Click on "Edit Config" to edit the `claude_desktop_config.json` file. :::{image} ./claude-developer-menu.png :alt: Navigate to the Developer tab ::: -3. Add the MCP server: Add an entry to the `mcpServers` object. If the `mcpServers` +3. Add the MCP server: Add an entry to the `mcpServers` object. If the `mcpServers` object does not exist, create one. ```json { "mcpServers": { "clp-mcp-server": { "command": "npx", "args": [ "-y", "mcp-remote", "http://<host>:<port>/mcp", "--allow-http", "--transport", "http-first" ] } } } ``` - The `host` and `port` values should match the hostname and port number where - the MCP server is running, as specified - during [configuration](../guides-mcp-server/index.md#starting-the-mcp-server). + The `host` and `port` values should match the hostname and port number where + the MCP server is running, as specified + during [configuration](../guides-mcp-server/index.md#starting-the-mcp-server). Check [mcp-remote]'s package description for additional arguments that can be specified. 4. Save the configuration: Save changes to the `claude_desktop_config.json` file -5. Restart Claude Desktop: Close and reopen the application for the +5. Restart Claude Desktop: Close and reopen the application for the new configuration to take effect. -6. You should now see the MCP server and its available tools under the +6. You should now see the MCP server and its available tools under the "Search and Tools" icon in Claude Desktop's Prompt window.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
docs/src/user-docs/guides-mcp-server/index.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-cursor.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-vscode.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/src/user-docs/guides-mcp-server/mcp-vscode.md
9-9: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
10-10: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
23-23: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
24-24: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
27-27: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
28-28: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
29-29: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
docs/src/user-docs/guides-mcp-server/mcp-cursor.md
8-8: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
23-23: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
24-24: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
27-27: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md
19-19: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
26-26: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
47-47: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
49-49: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
53-53: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
55-55: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (1)
docs/src/user-docs/guides-mcp-server/index.md (1)
1-87: All grid-item-card links resolve correctly to existing documentation files.The verification confirms that all three link references in the grid-item-card entries (
:link: mcp-claude-desktop,:link: mcp-cursor,:link: mcp-vscode) correspond exactly to the toctree entries and to the actual documentation files present in thedocs/src/user-docs/guides-mcp-server/directory:
mcp-claude-desktop.mdmcp-cursor.mdmcp-vscode.mdThe cross-references are properly configured and will resolve correctly.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/src/user-docs/guides-mcp-server/index.md (1)
72-78: Remove orphaned block closing marker at line 78.The Limitations section (lines 72–77) contains plain text without a corresponding block directive, yet line 78 has a closing
:::marker. This orphaned marker should be removed.Apply this diff:
CLP currently doesn't store timezone information in the compressed logs. This means that if the logs you compressed were *not* in the UTC timezone, you will need to tell your agent what timezone the logs were in originally. Support for encoding timezone information in the compressed logs will be available in a future release. -::: :::{toctree}
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
docs/src/user-docs/guides-mcp-server/index.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-cursor.md(1 hunks)docs/src/user-docs/guides-mcp-server/mcp-vscode.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md
19-19: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
26-26: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
47-47: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
49-49: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
53-53: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
55-55: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: lint-check (ubuntu-24.04)
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (2)
docs/src/user-docs/guides-mcp-server/mcp-vscode.md (1)
1-34: Documentation formatting looks good.The file structure is well-organized with proper code block formatting (language specifier, surrounding blank lines), and past linting issues appear to have been resolved. Content provides clear steps for connecting VSCode to the CLP MCP server.
docs/src/user-docs/guides-mcp-server/mcp-cursor.md (1)
1-32: Documentation formatting looks good.The file structure is well-organized with proper heading spacing, correct code block formatting (JSON language specifier, surrounding blank lines), and past linting issues appear to have been resolved. Content clearly explains how to connect Cursor to the CLP MCP server.
|
Removed trailing spaces by checking |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: lint-check (ubuntu-24.04)
🔇 Additional comments (2)
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md (2)
1-59: Content and structure look solid.The file is well-organized with clear prerequisites, step-by-step instructions, visual aids (images with alt text), and proper external references. The previous code formatting and linting issues appear to have been resolved. The configuration guidance is helpful and correctly references the mcp-remote package and internal setup documentation.
Please run the verification scripts above to confirm the internal link anchor exists and all markdown linting passes before merge.
47-50: Internal link anchor verified—no action required.The internal link reference to
#starting-the-mcp-serveris valid. The corresponding heading "## Starting the MCP Server" exists at line 22 in the index.md file, and Markdown will correctly resolve the anchor.
| # Connecting Claude Desktop | ||
|
|
||
| This guide explains how to connect [Claude Desktop][claude-desktop] | ||
| to the CLP MCP server over HTTP. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. Install Node.js >= 16 | ||
| 2. Install the [mcp-remote] package | ||
|
|
||
| ## Steps | ||
|
|
||
| 1. Open Claude Desktop settings. | ||
|
|
||
| :::{image} ./claude-settings.png | ||
| :alt: Open settings | ||
| ::: | ||
|
|
||
| 2. Navigate to the "Developer" tab in the sidebar. Click on "Edit Config" to edit | ||
| the `claude_desktop_config.json` file. | ||
|
|
||
| :::{image} ./claude-developer-menu.png | ||
| :alt: Navigate to the Developer tab | ||
| ::: | ||
|
|
||
| 3. Add the MCP server: Add an entry to the `mcpServers` object. If the `mcpServers` | ||
| object does not exist, create one. | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "clp-mcp-server": { | ||
| "command": "npx", | ||
| "args": [ | ||
| "-y", | ||
| "mcp-remote", | ||
| "http://<host>:<port>/mcp", | ||
| "--allow-http", | ||
| "--transport", | ||
| "http-first" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The `host` and `port` values should match the hostname and port number where | ||
| the MCP server is running, as specified | ||
| during [configuration](../guides-mcp-server/index.md#starting-the-mcp-server). | ||
| Check [mcp-remote]'s package description for additional arguments that can be specified. | ||
|
|
||
| 4. Save the configuration: Save changes to the `claude_desktop_config.json` file | ||
| 5. Restart Claude Desktop: Close and reopen the application for the | ||
| new configuration to take effect. | ||
| 6. You should now see the MCP server and its available tools under the | ||
| "Search and Tools" icon in Claude Desktop's Prompt window. | ||
|
|
||
| [claude-desktop]: https://claude.com/product/overview | ||
| [mcp-remote]: https://www.npmjs.com/package/mcp-remote |
There was a problem hiding this comment.
🧩 Analysis chain
Confirm all markdown linting issues have been resolved.
The file previously had MD009 (trailing spaces) violations. Please run the markdown linter locally to confirm the current version passes all checks.
🏁 Script executed:
#!/bin/bash
# Run the markdown linter on the file using the project's configuration
npx markdownlint-cli2 \
--config tools/yscope-dev-utils/exports/lint-configs/.markdownlint-cli2.yaml \
docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.mdLength of output: 1487
---
🏁 Script executed:
```shell
#!/bin/bash
# Find markdown lint configuration files
fd -e yaml -e json . tools/ 2>/dev/null | grep -i markdown || echo "No config found in tools/"
# Also check for .markdownlint* files at root
fd -e yaml -e json -H . | grep -i markdownlint | head -20
Length of output: 56
🏁 Script executed:
#!/bin/bash
# Run markdown linter without explicit config to use default or autodiscovered config
npx markdownlint-cli2 docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.mdLength of output: 277
🏁 Script executed:
#!/bin/bash
# Check if there's a .markdownlintrc or similar at repository root
ls -la | grep -i markdownLength of output: 167
Correct line-length violation on line 50 (MD013).
The markdown linter still reports an error on line 50:81 — line exceeds 80 characters (actual: 92). The line "Check [mcp-remote]'s package description for additional arguments that can be specified." must be shortened or wrapped.
🤖 Prompt for AI Agents
In docs/src/user-docs/guides-mcp-server/mcp-claude-desktop.md (lines 1-59) the
markdown linter flags line 50 for exceeding 80 characters; shorten or wrap the
sentence "Check [mcp-remote]'s package description for additional arguments that
can be specified." into two shorter sentences or otherwise rephrase so each line
is <=80 chars (for example split after "description." and continue with "See it
for additional arguments."). Ensure wrapping preserves the same meaning and
links remain intact.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-docs/guides-mcp-server/index.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (2)
docs/src/user-docs/guides-mcp-server/index.md (2)
54-77: All three linked guide files exist and are properly indexed in the toctree. No issues detected with the cross-references.
94-97: External links verified as current and accessible.All four external reference URLs in lines 94–97 are confirmed operational and pointing to valid resources. Each returned HTTP 200 status:
https://claude.com/product/overview✓https://cursor.com/✓https://modelcontextprotocol.io/docs/getting-started/intro✓https://code.visualstudio.com/✓No action required.
kirkrodrigues
left a comment
There was a problem hiding this comment.
Edited PR title directly.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/src/user-docs/guides-mcp-server/index.md (1)
88-91: Standardize "timezone" terminology to "time zone" (two words) for consistency with CLP documentation conventions.The Limitations section still uses "timezone" (one word) in four places, inconsistent with established CLP documentation style. Other documentation files (e.g.,
guides-retention.md,core-clp-s.md) consistently use "time zone" (two words). Additionally, "UTC timezone" is redundant since UTC is already a time zone designation.Apply this diff:
-CLP currently doesn't store timezone information in the compressed logs. This means that if the logs -you compressed were *not* in the UTC timezone, you will need to tell your agent what timezone the +CLP currently doesn't store time zone information in the compressed logs. This means that if the logs +you compressed were *not* in UTC, you will need to tell your agent what time zone the logs were in originally. Support for encoding timezone information in the compressed logs will be -available in a future release. +available in a future release.Based on learnings from prior CLP documentation reviews.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-docs/guides-mcp-server/index.md(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-08-15T21:48:46.674Z
Learnt from: quinntaylormitchell
Repo: y-scope/clp PR: 1181
File: docs/src/user-guide/guides-retention.md:57-66
Timestamp: 2025-08-15T21:48:46.674Z
Learning: When dealing with timezone offset adjustments for retention periods in CLP, the correct formula is `adjusted_retention_period = retention_period - UTC_offset` (not using absolute value). For negative UTC offsets, this increases the retention period; for positive UTC offsets, this decreases it, properly compensating for how local timestamps are interpreted by the UTC-based garbage collector.
Applied to files:
docs/src/user-docs/guides-mcp-server/index.md
📚 Learning: 2025-08-17T16:19:24.478Z
Learnt from: Bill-hbrhbr
Repo: y-scope/clp PR: 1100
File: integration-tests/README.md:5-6
Timestamp: 2025-08-17T16:19:24.478Z
Learning: In the CLP project, README.md files can have multiple H1 headings when it makes sense structurally (e.g., "Contributing" as a top-level section alongside the main title). The MD025 markdown linting rule should be ignored in such cases where multiple H1s are intentional.
Applied to files:
docs/src/user-docs/guides-mcp-server/index.md
📚 Learning: 2025-10-02T15:48:58.961Z
Learnt from: 20001020ycx
Repo: y-scope/clp PR: 1368
File: components/clp-mcp-server/clp_mcp_server/__init__.py:11-15
Timestamp: 2025-10-02T15:48:58.961Z
Learning: In the clp-mcp-server component (components/clp-mcp-server/clp_mcp_server/__init__.py), the default host binding of 0.0.0.0 is intentional because the server is designed to be deployed in Docker containers where this binding is necessary to accept external connections.
Applied to files:
docs/src/user-docs/guides-mcp-server/index.md
📚 Learning: 2025-10-20T20:19:40.504Z
Learnt from: 20001020ycx
Repo: y-scope/clp PR: 1436
File: components/clp-mcp-server/clp_mcp_server/clp_mcp_server.py:22-27
Timestamp: 2025-10-20T20:19:40.504Z
Learning: In the clp-mcp-server project (components/clp-mcp-server/clp_mcp_server/clp_mcp_server.py), the --config Click option should use exists=True to validate the configuration file path at option processing time, even though this requires the default path to exist on all machines.
Applied to files:
docs/src/user-docs/guides-mcp-server/index.md
🪛 LanguageTool
docs/src/user-docs/guides-mcp-server/index.md
[uncategorized] ~57-~57: Possible missing comma found.
Context: ...roneous queries from the agent, in your prompt you can tell the agent to read the MCP ...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (1)
docs/src/user-docs/guides-mcp-server/index.md (1)
24-49: Code structure and configuration guidance look well-structured.The configuration steps, inline notes, and quickstart references align with previous reviewer suggestions and provide clear guidance for users.
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Description
This request will update user documentation to add:
Checklist
breaking change.
Validation performed
Summary by CodeRabbit