Add docs for MCP Server and VSCode Extension #3475

strickvl · 2025-03-28T15:05:32Z

Added docs / images for

MCP Server
VSCode Extension (added @marwan37 to ensure I didn't mess anything up)

coderabbitai · 2025-03-28T15:05:40Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This PR adds documentation for two new features: the ZenML VSCode extension and the MCP Server chat interface, along with updating the table of contents.

Added a new doc page for the ZenML VSCode extension including installation and usage instructions.
Added a new doc page detailing how to chat with your ZenML server via the Model Context Protocol (MCP).
Updated the Table of Contents to include links to both new pages.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

File	Description
docs/book/toc.md	Added entries for the VSCode extension and MCP chat interface docs.
docs/book/how-to/manage-zenml-server/vscode-extension.md	Introduces comprehensive installation and feature descriptions for the ZenML VSCode extension.
docs/book/how-to/manage-zenml-server/mcp-chat-with-server.md	Provides an overview and setup instructions for interacting with ZenML server via a chat interface using MCP.

Comments suppressed due to low confidence (1)

docs/book/how-to/manage-zenml-server/vscode-extension.md:11

[nitpick] The reference to 'Cursor' may be unclear in this context. Consider clarifying if 'Cursor' is an intended supported editor or updating the reference to avoid potential confusion.

which means that Cursor also supports this extension.

github-actions · 2025-03-28T15:07:12Z

Documentation Link Check Results

✅ Absolute links check passed
✅ Relative links check passed
_{Last checked: 2025-03-28 15:58:35 UTC}

github-actions · 2025-03-28T15:10:06Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 1.1%, saving 467 bytes.

Filename	Before	After	Improvement	Visual comparison
`docs/book/user-guide/.gitbook/assets/gamesense.jpg`	9.06 KB	8.97 KB	-1.1%	View diff
`docs/book/user-guide/.gitbook/assets/nightwatch.jpg`	12.18 KB	12.05 KB	-1.1%	View diff
`docs/book/user-guide/.gitbook/assets/researchradar.jpg`	11.12 KB	11.00 KB	-1.1%	View diff
`docs/book/user-guide/.gitbook/assets/yolo.jpg`	10.55 KB	10.45 KB	-1.0%	View diff

487 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

strickvl · 2025-03-28T15:24:47Z

@htahir1 how did you handle things like this pastebin.com URL failing the URL check... should I implement an list of exceptions or something?

docs/book/toc.md

docs/book/user-guide/.gitbook/assets/gamesense.jpg

htahir1 · 2025-03-28T15:25:31Z

@strickvl no i didnt handle it i just always change the URL

…io/zenml into doc/mcp-vscode-docs-consolidation

marwan37

@strickvl vscode extension docs looks good ✅

* add mcp docs * Add vscode extension docs * Update TOC * Optimised images with calibre/image-actions * Fix broken URL --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 4f406c1)

strickvl added 3 commits March 28, 2025 15:35

add mcp docs

10cb91f

Add vscode extension docs

60acb81

Update TOC

1f06c02

strickvl added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels Mar 28, 2025

strickvl requested review from htahir1, marwan37 and Copilot March 28, 2025 15:05

Copilot AI reviewed Mar 28, 2025

View reviewed changes

Merge branch 'develop' into doc/mcp-vscode-docs-consolidation

e9d8be1

Optimised images with calibre/image-actions

aa59115

htahir1 approved these changes Mar 28, 2025

View reviewed changes

docs/book/toc.md Show resolved Hide resolved

docs/book/user-guide/.gitbook/assets/gamesense.jpg Outdated Show resolved Hide resolved

strickvl added 2 commits March 28, 2025 16:56

Fix broken URL

a3ff78c

Merge branch 'doc/mcp-vscode-docs-consolidation' of github.com:zenml-…

0fec793

…io/zenml into doc/mcp-vscode-docs-consolidation

marwan37 reviewed Mar 28, 2025

View reviewed changes

strickvl merged commit 4f406c1 into develop Mar 28, 2025
11 checks passed

strickvl deleted the doc/mcp-vscode-docs-consolidation branch March 28, 2025 16:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add docs for MCP Server and VSCode Extension #3475

Add docs for MCP Server and VSCode Extension #3475

Uh oh!

strickvl commented Mar 28, 2025

Uh oh!

coderabbitai bot commented Mar 28, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions bot commented Mar 28, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 28, 2025

Uh oh!

strickvl commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

htahir1 commented Mar 28, 2025

Uh oh!

marwan37 left a comment

Uh oh!

Uh oh!

Uh oh!

Add docs for MCP Server and VSCode Extension #3475

Add docs for MCP Server and VSCode Extension #3475

Uh oh!

Conversation

strickvl commented Mar 28, 2025

Uh oh!

coderabbitai bot commented Mar 28, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

github-actions bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

github-actions bot commented Mar 28, 2025

Uh oh!

strickvl commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

htahir1 commented Mar 28, 2025

Uh oh!

marwan37 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 28, 2025 •

edited

Loading