vizro-mcp 0.0.1.dev0__py3-none-any.whl → 0.1.1__py3-none-any.whl

vizro_mcp/__init__.py

@@ -3,7 +3,7 @@ import sys
 
 from .server import mcp
 
-__version__ = "0.0.1.dev0"
+__version__ = "0.1.1"
 
 
 def main():

vizro_mcp/server.py

@@ -99,7 +99,7 @@ def get_sample_data_info(data_name: Literal["iris", "tips", "stocks", "gapminder
 
 @mcp.tool()
 def validate_model_config(
-    config: dict[str, Any],
+    dashboard_config: dict[str, Any],
     data_infos: list[DFMetaData],  # Should be Optional[..]=None, but Cursor complains..
     auto_open: bool = True,
 ) -> ValidationResults:
@@ -109,7 +109,7 @@ def validate_model_config(
     The PyCafe link will be automatically opened in your default browser if auto_open is True.
 
     Args:
-        config: Either a JSON string or a dictionary representing a Vizro model configuration
+        dashboard_config: Either a JSON string or a dictionary representing a Vizro dashboard model configuration
         data_infos: List of DFMetaData objects containing information about the data files
         auto_open: Whether to automatically open the PyCafe link in a browser
 
@@ -119,7 +119,7 @@ def validate_model_config(
     Vizro._reset()
 
     try:
-        dashboard = vm.Dashboard.model_validate(config)
+        dashboard = vm.Dashboard.model_validate(dashboard_config)
     except ValidationError as e:
         return ValidationResults(
             valid=False,
@@ -333,14 +333,14 @@ Create an EDA dashboard based on the following dataset:{file_path_or_url}. Proce
 
 @mcp.tool()
 def validate_chart_code(
-    config: ChartPlan,
+    chart_config: ChartPlan,
     data_info: DFMetaData,
     auto_open: bool = True,
 ) -> ValidationResults:
     """Validate the chart code created by the user and optionally open the PyCafe link in a browser.
 
     Args:
-        config: A ChartPlan object with the chart configuration
+        chart_config: A ChartPlan object with the chart configuration
         data_info: Metadata for the dataset to be used in the chart
         auto_open: Whether to automatically open the PyCafe link in a browser
 
@@ -350,7 +350,7 @@ def validate_chart_code(
     Vizro._reset()
 
     try:
-        chart_plan_obj = ChartPlan.model_validate(config)
+        chart_plan_obj = ChartPlan.model_validate(chart_config)
     except ValidationError as e:
         return ValidationResults(
             valid=False,

{vizro_mcp-0.0.1.dev0.dist-info → vizro_mcp-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vizro-mcp
-Version: 0.0.1.dev0
+Version: 0.1.1
 Summary: MCP server to help create Vizro dashboards and charts
 Author: Vizro Team
 License-File: LICENSE.txt
@@ -17,21 +17,39 @@ Requires-Dist: pandas[excel,html,parquet]
 Requires-Dist: vizro==0.1.38
 Description-Content-Type: text/markdown
 
+<a href="https://glama.ai/mcp/servers/@mckinsey/vizro">
+  <img width="380" height="200" src="https://glama.ai/mcp/servers/@mckinsey/vizro/badge" />
+</a>
+
 # Vizro MCP server
 
 Vizro-MCP is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server, which works alongside a LLM to help you create Vizro dashboards and charts.
 
+![Vizro MCP Demo](assets/vizro-mcp.gif)
+
 ## Features of Vizro-MCP
 
 Vizro-MCP provides tools and templates to create a functioning Vizro chart or dashboard step by step. Benefits include:
 
-✅ One consistent framework for charts and dashboards with one common design language. ✅ Validated config output that is readable and easy to alter or maintain. ✅ Live preview of the dashboard to iterate the design until the dashboard is perfect. ✅ Use of local or remote datasets simply by providing a path or URL.
+✅ One consistent framework for charts and dashboards with one common design language.
+
+✅ Validated config output that is readable and easy to alter or maintain.
+
+✅ Live preview of the dashboard to iterate the design until the dashboard is perfect.
+
+✅ Use of local or remote datasets simply by providing a path or URL.
 
 ### Without Vizro-MCP
 
 Without Vizro-MCP, if you try to make a dashboard using an LLM, it could choose any framework, and use it without specific guidance, design principles, or consistency. The results are:
 
-❌ A random choice of frontend framework or charting library. ❌ A vibe-coded mess that may or may not run, but certainly is not very maintainable. ❌ No way to easily preview the dashboard. ❌ No easy way to connect to real data.
+❌ A random choice of frontend framework or charting library.
+
+❌ A vibe-coded mess that may or may not run, but certainly is not very maintainable.
+
+❌ No way to easily preview the dashboard.
+
+❌ No easy way to connect to real data.
 
 ## 🛠️ Get started
 
@@ -48,10 +66,27 @@ In principle, the Vizro MCP server works with _any_ MCP enabled LLM applications
 
 > ⚠️ **Warning:** In some hosts (like Claude Desktop) the free plan might be less performant, which may cause issues when the request is too complex. In cases where the request causes the UI to crash, opt for using a paid plan, or reduce your request's complexity.
 
-## Setup Instructions
+### Setup Instructions
+
+The general server config is mostly the same for all hosts:
+
+```json
+{
+  "mcpServers": {
+    "vizro-mcp": {
+      "command": "uvx",
+      "args": [
+        "vizro-mcp"
+      ]
+    }
+  }
+}
+```
+
+In principle, the Vizro MCP server works with _any_ MCP enabled LLM applications but we recommend Claude Desktop or Cursor as popular choices (see more detailed instructions below). Different AI tools may use different setup methods or connection settings. Check each tool's docs for details.
 
 <details>
-<summary><strong>Claude</strong></summary>
+<summary><strong>Claude Desktop</strong></summary>
 
 Add the following to your `claude_desktop_config.json` [found via Developer Settings](https://modelcontextprotocol.io/quickstart/user#2-add-the-filesystem-mcp-server).
 
@@ -68,7 +103,7 @@ Add the following to your `claude_desktop_config.json` [found via Developer Sett
 }
 ```
 
-> ⚠️ **Warning:** In some cases you may need to provide the full path to your `uv` executable, so instead of `uv` would use something like `/Users/<your-username>/.local/bin/uv`. To discover the path of `uv` on your machine, in your terminal app, type `which uv`.
+> ⚠️ **Warning:** In some cases you may need to provide the full path to your `uvx` executable, so instead of `uvx` would use something like `/Users/<your-username>/.local/bin/uvx`. To discover the path of `uvx` on your machine, in your terminal app, type `which uvx`.
 
 If you are using Claude Desktop, restart it, and after a few moments, you should see the vizro-mcp menu when opening the settings/context menu:
 
@@ -94,7 +129,7 @@ Add the following to `mcp.json` [found via the Cursor Settings](https://docs.cur
 }
 ```
 
-> ⚠️ **Warning:** In some cases you may need to provide the full path to your `uv` executable, so instead of `uv` would use something like `/Users/<your-username>/.local/bin/uv`. To discover the path of `uv` on your machine, in your terminal app, type `which uv`.
+> ⚠️ **Warning:** In some cases you may need to provide the full path to your `uvx` executable, so instead of `uvx` would use something like `/Users/<your-username>/.local/bin/uvx`. To discover the path of `uvx` on your machine, in your terminal app, type `which uvx`.
 
 Similarly, when using Cursor, after a short pause, you should see a green light in the MCP menu:
 
@@ -102,8 +137,6 @@ Similarly, when using Cursor, after a short pause, you should see a green light
 
 </details>
 
-In principle, the Vizro MCP server works with _any_ MCP enabled LLM applications but we recommend Claude Desktop or Cursor as popular choices. Different AI tools may use different setup methods or connection settings. Check each tool's docs for details.
-
 ## 💻 Usage
 
 ### Use prompt templates to get specific dashboards quickly
@@ -122,6 +155,8 @@ You can also ask the LLM to create specific dashboards based on local or remote
 
 > _Create a simple two page Vizro dashboard, with first page being a correlation analysis of `<insert absolute file path or public URL>` data, and the second page being a map plot of `<insert absolute file path or public URL>` data_
 
+You can find a set of sample CSVs to try out in the [Plotly repository](https://github.com/plotly/datasets/tree/master).
+
 You can even ask for a dashboard without providing data:
 
 > _Create a Vizro dashboard with one page, a scatter chart, and a filter._
@@ -138,9 +173,11 @@ You can also ask the model to give you the link, but it will attempt to regenera
 
 ### Create Vizro charts
 
-The **easiest** way to get started with Vizro charts is to choose the template `create_vizro_chart` and just send the prompt. This will create a simple chart that you can alter. Take it from there!
+If you don't want to create an entire Vizro dashboard, you can still use Vizro-MCP to create the code for a single chart. If you're not sure what kind of chart you want, check out the [Vizro Visual Vocabulary](https://huggingface.co/spaces/vizro/demo-visual-vocabulary) for ideas.
 
-Alternatively, you can just ask in the chat things like:
+The **easiest** way to create a Vizro chart is to choose the template `create_vizro_chart` and just send the prompt. This will create a simple chart that you can alter. Take it from there!
+
+Alternatively, you can just ask in the chat, for example:
 
 > _Create a scatter based on the iris dataset._
 
@@ -168,12 +205,8 @@ The Vizro MCP server provides the following tools. In general you should not nee
 ## Available Prompts (if client allows)
 
 - `create_starter_dashboard` - Use this prompt template to get started with Vizro dashboards.
-- `create_EDA_dashboard` - Use this prompt template to create an Exploratory Data Analysis (EDA) dashboard based on a local or remote CSV dataset
-- `create_vizro_chart` - Use this prompt template to create a Vizro styled plotly chart based on a local or remote CSV dataset
-
-## Sample data
-
-You can find a set of sample CSVs to try out in the [Plotly repository](https://github.com/plotly/datasets/tree/master).
+- `create_EDA_dashboard` - Use this prompt template to create an Exploratory Data Analysis (EDA) dashboard based on a local or remote CSV dataset.
+- `create_vizro_chart` - Use this prompt template to create a Vizro styled plotly chart based on a local or remote CSV dataset.
 
 ## Development or running from source
 
@@ -201,12 +234,67 @@ If you are a developer, or if you are running Vizro-MCP from source, you need to
 
 Replace `<PATH TO VIZRO>` with the actual path to your Vizro repository. You may also need to provide the full path to your `uv` executable, so instead of `"uv"` you would use something like `"/Users/<your-username>/.local/bin/uv"`. To discover the path of `uv` on your machine, in your terminal app, type `which uv`.
 
-## Other cool MCP Servers
+## Disclaimers
+
+<details>
+<summary><strong>Third party API</strong></summary>
+
+Users are responsible for anything done via their host LLM application.
+
+Users are responsible for procuring any and all rights necessary to access any third-party generative AI tools and for complying with any applicable terms or conditions thereof.
+
+Users are wholly responsible for the use and security of the third-party generative AI tools and of Vizro.
+
+</details>
+
+<details>
+<summary><strong>User acknowledgments</strong></summary>
+
+Users acknowledge and agree that:
+
+Any results, options, data, recommendations, analyses, code, or other information (“Outputs”) generated by any third-party generative AI tools (“GenAI Tools”) may contain some inaccuracies, biases, illegitimate, potentially infringing, or otherwise inappropriate content that may be mistaken, discriminatory, or misleading.
+
+McKinsey & Company:
+
+(i) expressly disclaims the accuracy, adequacy, timeliness, reliability, merchantability, fitness for a particular purpose, non-infringement, safety or completeness of any Outputs,
+
+(ii) shall not be liable for any errors, omissions, or other defects in, delays or interruptions in such Outputs, or for any actions taken in reliance thereon, and
 
-Here are some other awesome MCP servers you might want to check out:
+(iii) shall not be liable for any alleged violation or infringement of any right of any third party resulting from the users’ use of the GenAI Tools and the Outputs.
 
-- [Context7](https://github.com/upstash/context7) - Provides up-to-date code documentation for any library directly in your prompts. Great for getting the latest API references and examples without relying on outdated training data.
+The Outputs shall be verified and validated by the users and shall not be used without human oversight and as a sole basis for making decisions impacting individuals.
 
-- [Everything MCP](https://github.com/modelcontextprotocol/servers/tree/main/src/everything) - A development-focused MCP server that combines multiple capabilities including web search, code search, and more. Useful for testing and prototyping MCP features. Part of the official MCP servers collection.
+Users remain solely responsible for the use of the Output, in particular, the users will need to determine the level of human oversight needed to be given the context and use case, as well as for informing the users’ personnel and other affected users about the nature of the GenAI Output. Users are also fully responsible for their decisions, actions, use of Vizro and Vizro-MCP and compliance with applicable laws, rules, and regulations, including but not limited to confirming that the Outputs do not infringe any third-party rights.
 
-You can find more MCP servers in the [official MCP servers repository](https://github.com/modelcontextprotocol/servers/tree/main).
+</details>
+
+<details>
+<summary><strong>Warning and safety usage for generative AI models</strong></summary>
+
+Vizro-MCP is used by generative AI models because large language models (LLMs) represent significant advancements in the AI field. However, as with any powerful tool, there are potential risks associated with connecting to a generative AI model.
+
+We recommend users research and understand the selected model before using Vizro-MCP.
+
+Users are encouraged to treat AI-generated content as supplementary, always apply human judgment, approach with caution, review the relevant disclaimer page, and consider the following:
+
+<ol>
+<li>Hallucination and misrepresentation</li>
+Generative models can potentially generate information while appearing factual, being entirely fictitious or misleading.
+
+The vendor models might lack real-time knowledge or events beyond its last updates. Vizro-MCP output may vary and you should always verify critical information. It is the user's responsibility to discern the accuracy, consistent, and reliability of the generated content.
+
+<li>Unintended and sensitive output</li>
+The outputs from these models can be unexpected, inappropriate, or even harmful. Users as human in the loop is an essential part. Users must check and interpret the final output. It is necessary to approach the generated content with caution, especially when shared or applied in various contexts.
+
+<li>Data privacy</li>
+Your data is sent to model vendors if you connect to LLMs via their APIs. For example, if you connect to the model from OpenAI, your data will be sent to OpenAI via their API. Users should be cautious about sharing or inputting any personal or sensitive information.
+
+<li>Bias and fairness</li>
+Generative AI can exhibit biases present in their training data. Users need to be aware of and navigate potential biases in generated outputs and be cautious when interpreting the generated content.
+
+<li>Malicious use</li>
+These models can be exploited for various malicious activities. Users should be cautious about how and where they deploy and access such models.
+</ol>
+It's crucial for users to remain informed, cautious, and ethical in their applications.
+
+</details>

vizro_mcp-0.1.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+vizro_mcp/__init__.py,sha256=nZUsEUDlifJKJw3pG-tvzH7nFxmoPTn85wrORwWWYjs,379
+vizro_mcp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vizro_mcp/server.py,sha256=mQEyb8MS0L_WVtIhee7oknLZzl2N5QIXsxUiiKHM6Dc,14871
+vizro_mcp/_schemas/__init__.py,sha256=przXt7ukurnDlj3SLRW-K0VO1ksnDDFuS8Njf80xepo,610
+vizro_mcp/_schemas/schemas.py,sha256=r_0i9fRtyMh7W3q3KgnpCbRUDlBaFjG6XQjCtahgEXc,11625
+vizro_mcp/_utils/__init__.py,sha256=q-xdwiyRCaOWWTeG5NC_1CzHWXBH4sUKpIBXbUaKg_Y,670
+vizro_mcp/_utils/utils.py,sha256=gIuKXONR2SvOgA3Vo3ONnkh8Qcc-RLfrexJAjan12zk,9217
+vizro_mcp-0.1.1.dist-info/METADATA,sha256=CmPmKTtiJHsANF4eYGNFJrRiLLiGMM6Odgrv3XHC12w,16027
+vizro_mcp-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+vizro_mcp-0.1.1.dist-info/entry_points.txt,sha256=iSUzPHvx4Ogsn91tK2C0OHxI44SNCHT1F1zUqbTj5O0,45
+vizro_mcp-0.1.1.dist-info/licenses/LICENSE.txt,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+vizro_mcp-0.1.1.dist-info/RECORD,,

vizro_mcp-0.0.1.dev0.dist-info/RECORD

@@ -1,12 +0,0 @@
-vizro_mcp/__init__.py,sha256=rARL6i447w01mUjVtn3WBb3noEgTzbrNqBinR5SUyrs,384
-vizro_mcp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vizro_mcp/server.py,sha256=cINRBPr0hkN5S5tD_Gf6dYu8vC7QviYCOrCtiAxYYwU,14813
-vizro_mcp/_schemas/__init__.py,sha256=przXt7ukurnDlj3SLRW-K0VO1ksnDDFuS8Njf80xepo,610
-vizro_mcp/_schemas/schemas.py,sha256=r_0i9fRtyMh7W3q3KgnpCbRUDlBaFjG6XQjCtahgEXc,11625
-vizro_mcp/_utils/__init__.py,sha256=q-xdwiyRCaOWWTeG5NC_1CzHWXBH4sUKpIBXbUaKg_Y,670
-vizro_mcp/_utils/utils.py,sha256=gIuKXONR2SvOgA3Vo3ONnkh8Qcc-RLfrexJAjan12zk,9217
-vizro_mcp-0.0.1.dev0.dist-info/METADATA,sha256=nCTKmpfHmHJ6h5TjlZ5zKVqk-CMhal9Ca1QhakaJITo,11747
-vizro_mcp-0.0.1.dev0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-vizro_mcp-0.0.1.dev0.dist-info/entry_points.txt,sha256=iSUzPHvx4Ogsn91tK2C0OHxI44SNCHT1F1zUqbTj5O0,45
-vizro_mcp-0.0.1.dev0.dist-info/licenses/LICENSE.txt,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-vizro_mcp-0.0.1.dev0.dist-info/RECORD,,