Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@royendo
Copy link
Contributor

@royendo royendo commented May 22, 2025

INSERT DESCRIPTION HERE

Checklist:

  • Covered by tests
  • Ran it and it works as intended
  • Reviewed the diff before requesting a review
  • Checked for unhandled edge cases
  • Linked the issues it closes
  • Checked if the docs need to be updated
  • Intend to cherry-pick into the release branch
  • I'm proud of this work!

@begelundmuller
Copy link
Contributor

@royendo FYI we now support MCP both for Rill Developer and Rill Cloud, and the setup has become a bit simpler. More details here: #7357

  1. For Rill Developer and for Rill Cloud demo projects, you don't need an access token, just the URL
  2. For private projects in Rill Cloud, use rill token issue to get a personal access token (unlike service tokens, it's available for everyone including project guests, and security policies are enforced)

@royendo royendo requested a review from mindspank May 28, 2025 15:01
@royendo royendo marked this pull request as ready for review May 28, 2025 15:01
@royendo
Copy link
Contributor Author

royendo commented May 28, 2025

@mindspank , plan to release this tomorrow morning with the blog, etc.
But might be a good idea to get this in early so that the link on the blog will work.

LMK any changes needed :)

@@ -0,0 +1,158 @@
---
title: "Rill MCP Server"
description: How to connect to Rill MCP and query your deployment
Copy link
Contributor

Choose a reason for hiding this comment

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

query your data or query your metrics views might be more appropriate

Comment on lines 29 to 36
### Create a Rill service token (if your project is on Rill Cloud)
```
# Install the Rill CLI if you haven't already
curl https://rill.sh | sh

# Create a service token
rill service create mcp-server
```
Copy link
Contributor

Choose a reason for hiding this comment

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

We should recommend user tokens, not service tokens. See: #7359

Copy link
Contributor Author

Choose a reason for hiding this comment

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

:done:, you think we'll have the UI in time to put a screenshot here and steps to get creds in the UI?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes! Polishing it up now

@royendo royendo requested review from ericpgreen2 and mindspank May 29, 2025 01:28
@avaitla
Copy link

avaitla commented May 29, 2025

Should there also be docs on installing mcp-remote package? It only says you need nodejs which is a bit barebones

@mindspank mindspank changed the title Docs/ MCP Server docs: MCP Server May 29, 2025
@mindspank
Copy link
Contributor

Should there also be docs on installing mcp-remote package? It only says you need nodejs which is a bit barebones

You shouldn't need to install it, npx should auto install it however we could add a -y flag to ensure confirmation on install is accepted per automatic. @ericpgreen2 see any issues with that?


The Rill Model Context Protocol (MCP) server exposes Rill's most essential APIs to LLMs. It's designed primarily for data analysts, not data engineers, and focuses on consuming Rill metric views—not creating them.

The server can also generate VegaLite-backed visualizations from natural language prompts and data tables. However, not all MCP clients support the Image datatype.
Copy link
Contributor

Choose a reason for hiding this comment

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

@ericpgreen2 is this still the case?

Copy link
Contributor

Choose a reason for hiding this comment

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

No, good catch, it doesn't generate visualizations currently.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed.

@ericpgreen2
Copy link
Contributor

Should there also be docs on installing mcp-remote package? It only says you need nodejs which is a bit barebones

You shouldn't need to install it, npx should auto install it however we could add a -y flag to ensure confirmation on install is accepted per automatic. @ericpgreen2 see any issues with that?

No issue with that. It looks like that's a common troubleshooting step that mcp-remote recommends:
image

@avaitla
Copy link

avaitla commented May 29, 2025

What part of the yaml is retrieved for the llm to help decide which metrics view to use? Is it the "description" for the metricsviews to decide the right metrics view and the "description" field on each dim and measure to decide what to query? Referencing that information encourages folks to better improve their docs to get better results from their llm: https://docs.rilldata.com/reference/project-files/metrics-views

If descriptions are pulled this would also help us tell the LLM which metrics views to NOT use (in the yaml description) as they may be prototypes not suitable for reporting, and thus get better results out of the box.

Screenshot 2025-05-29 at 12 32 14 PM

It seems to only have access to the name of the metricsview and dims/measures which is something that should be improved soon:

names = append(names, r.Meta.Name.Name)

@begelundmuller

@ericpgreen2
Copy link
Contributor

Because v63 is live, we need to publish this docs page so we don't have a broken link in the application. I'll approve & merge, and we can take follow-ups in a separate PR.

@ericpgreen2 ericpgreen2 merged commit 2d9961c into main May 29, 2025
4 checks passed
@ericpgreen2 ericpgreen2 deleted the docs-explore-mcp branch May 29, 2025 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants