Vizro-MCP は、LLM と連携して Vizro ダッシュボードとグラフの作成を支援するモデル コンテキスト プロトコル (MCP)サーバーです。
Vizro-MCPは、機能的なVizroチャートやダッシュボードを段階的に作成するためのツールとテンプレートを提供します。次のようなメリットがあります。
✅ 共通のデザイン言語を使用した、チャートとダッシュボードのための一貫したフレームワーク。
✅ 読み取り可能で、変更や保守が容易な検証済みの構成出力。
✅ ダッシュボードのライブプレビューにより、ダッシュボードが完璧になるまでデザインを反復できます。
✅ パスまたは URL を指定するだけで、ローカルまたはリモートのデータセットを使用できます。
Vizro-MCPがなければ、LLMを使ってダッシュボードを作成しようとすると、特定のガイドラインや設計原則、一貫性のないフレームワークが勝手に使われてしまう可能性があります。その結果、次のようなことが起こります。
❌ フロントエンド フレームワークまたはチャート ライブラリのランダムな選択。
❌ 実行されるかどうかわからない、しかし保守性が非常に低い、バイブコーディングされた混乱。
❌ ダッシュボードを簡単にプレビューする方法がありません。
❌ 実際のデータに接続する簡単な方法はありません。
Related MCP server: ML Research MCP
開発者であり、Vizro-MCP をソースから実行する方法、または Docker コンテナーからサーバーを実行する方法についての手順が必要な場合は、このページの末尾の「開発」または「ソースからの実行」に進んでください。
🐛**注:**現在、 VS Codeにはいくつかの既知の問題がありますが、私たちはこれに取り組んでおり、Copilot がすぐに機能することを期待しています。
⚠️**注意：**一部のホスト（Claude Desktop など）では、無料プランのパフォーマンスが低下する可能性があり、リクエストが複雑すぎると問題が発生する可能性があります。リクエストによって UI がクラッシュする場合は、有料プランをご利用いただくか、リクエストの複雑さを軽減してください。
一般的なサーバー構成は、すべてのホストでほぼ同じです。
{
"mcpServers": {
"vizro-mcp": {
"command": "uvx",
"args": [
"vizro-mcp"
]
}
}
}原則として、Vizro MCPサーバーはMCP対応のLLMアプリケーションであればどれでも動作しますが、Claude DesktopまたはCursorを推奨します（詳細は下記をご覧ください）。AIツールによって設定方法や接続設定が異なる場合があります。詳細は各ツールのドキュメントをご確認ください。
開発者設定から見つかったclaude_desktop_config.jsonに次の内容を追加します。
{
"mcpServers": {
"vizro-mcp": {
"command": "uvx",
"args": [
"vizro-mcp"
]
}
}
}⚠️**警告:**場合によっては、
uvx実行ファイルへのフルパスを指定する必要があるかもしれません。そのため、uvxの代わりに/Users/<your-username>/.local/bin/uvxのようなパスを使用してください。お使いのマシン上のuvxのパスを確認するには、ターミナルアプリでwhich uvxと入力してください。
Claude Desktop を使用している場合は、再起動し、しばらくすると、設定/コンテキスト メニューを開いたときに vizro-mcp メニューが表示されます。
カーソル設定で見つかったmcp.jsonに次のコードを追加します。
{
"mcpServers": {
"vizro-mcp": {
"command": "uvx",
"args": [
"vizro-mcp"
]
}
}
}⚠️**警告:**場合によっては、
uvx実行ファイルへのフルパスを指定する必要があるかもしれません。そのため、uvxの代わりに/Users/<your-username>/.local/bin/uvxのようなパスを使用してください。お使いのマシン上のuvxのパスを確認するには、ターミナルアプリでwhich uvxと入力してください。
同様に、カーソルを使用する場合、少し待つと、MCP メニューに緑色のライトが表示されます。
プロンプトテンプレートはすべてのMCPホストで利用できるわけではありませんが、利用できる場合は、特定のダッシュボードを素早く取得するために使用できます。（Claude Desktopなどで）プロンプトテンプレートにアクセスするには、チャットの下にあるプラスアイコンをクリックし、 *Add from vizro-mcp*を選択してください。
Vizroダッシュボードを使い始める最も簡単な方法は、テンプレートcreate_starter_dashboardを選択し、プロンプトを送信するだけです。これで、1ページ、1つのチャート、1つのフィルターを含む非常にシンプルなダッシュボードが作成されます。さあ、始めましょう！
すでにご希望のイメージが固まっている場合は、LLMにローカルまたはリモートデータに基づいた特定のダッシュボードの作成を依頼することもできます。例えば、以下のような依頼が可能です。
1 ページ、散布図、および
<insert absolute file path or public URL>データに基づくフィルターを含む Vizro ダッシュボードを作成します。
シンプルな 2 ページの Vizro ダッシュボードを作成します。最初のページは
<insert absolute file path or public URL>データの相関分析、2 番目のページは<insert absolute file path or public URL>データのマップ プロットになります。
Plotly リポジトリには、試してみるためのサンプル CSV のセットが用意されています。
データを提供せずにダッシュボードを要求することもできます。
1 ページ、散布図、フィルターを含む Vizro ダッシュボードを作成します。
一般的に、プロンプトで Vizro を指定して、それをできるだけ正確 (かつシンプル) に保つことが役立ちます。
LLMがvalidate_model_configツールの使用を選択し、ツールが正常に実行されると、URL経由でアクセスされた公開データのみが使用されている場合、LLMはダッシュボードのライブプレビューへのリンクを返します。デフォルトでは、LLMはブラウザでリンクを開きます（開かないように指示しない限り）。Claude Desktopでは、ツールの折りたたみアイコンを開き、一番下までスクロールすることで、ツールの出力を確認できます。
モデルにリンクを提供するよう要求することもできますが、モデルはリンクを再生成しようとするため、エラーが発生しやすく、処理が遅くなります。
Vizroダッシュボード全体を作成したくない場合でも、Vizro-MCPを使用して単一のチャートのコードを作成できます。どのようなチャートを作成したいか分からない場合は、 Vizro Visual Vocabularyでアイデアを得てください。
Vizroチャートを作成する最も簡単な方法は、テンプレートcreate_vizro_chartを選択し、プロンプトを送信するだけです。これでシンプルなチャートが作成され、自由に編集できます。さあ、ここから始めましょう！
あるいは、チャットで質問することもできます。たとえば、次のようになります。
アイリス データセットに基づいて散布図を作成します。
<insert absolute file path or public URL>データに基づいて棒グラフを作成します。
MCPサーバーは比較的新しい概念であり、ユーザーとして十分な情報に基づいた選択を行うためには、ツールの機能について透明性を保つことが重要です。Vizro MCPサーバーは基本的にデータの読み取りのみを行い、マシン上のデータの書き込み、削除、変更は一切行いません。
一般的に、このプロセスで最も重要な部分はload_and_analyze_dataツールです。このツールは、お使いのマシン上で実行され、ローカルまたはリモートのデータをpandas DataFrameに読み込み、その構造とコンテンツの詳細な分析を提供しますpd.read_xxxのみを使用するため、プライバシーやデータセキュリティについて心配する必要はありません。ただし、Vizro-MCPはアクセスを管理するための認証機能がないため、ホストサーバーではなくローカルでのみ実行する必要があります。
2番目に重要な部分は、 validate_model_configツールです。このツールは、Vizroモデル設定のインスタンス化を試み、有効な設定のPythonコードと可視化リンクを返します。設定が有効な場合は、ダッシュボードのライブプレビューへのリンクを返して開こうとします。このリンクをクリックすると、 PyCafeが開きます。リンクを開きたくない場合は、LLMに開かないように指示できます。
Vizro MCPサーバーは以下のツールを提供します。通常は直接使用する必要はありませんが、特別な場合にはLLMにこれらのツールを直接呼び出すように指示することで、LLMがパスを見つけるのを手助けすることができます。
get_vizro_chart_or_dashboard_plan - チャートまたはダッシュボードを作成するための、体系的なステップバイステップのプランを入手します。作成プロセス全体に関するガイダンスを提供します。
get_model_JSON_schema - 指定された Vizro モデルの完全な JSON スキーマを取得します。必須およびオプションのパラメータを理解するのに役立ちます。
validate_model_config - Vizroモデル構成のインスタンス化を試行してテストします。有効な構成のPythonコードと可視化リンクを返します。
load_and_analyze_csv - ローカル パスまたは URL から CSV ファイルを pandas DataFrame に読み込み、その構造とコンテンツの詳細な分析を提供します。
validate_chart_code - チャート用に作成されたコードを検証し、その正確性に関するフィードバックを返します。
get_sample_data_info - テストと開発に使用できるサンプル データセットに関する情報を提供します。
create_starter_dashboard - このプロンプト テンプレートを使用して、Vizro ダッシュボードの使用を開始します。
create_EDA_dashboard - このプロンプト テンプレートを使用して、ローカルまたはリモートの CSV データセットに基づいて探索的データ分析 (EDA) ダッシュボードを作成します。
create_vizro_chart - このプロンプト テンプレートを使用して、ローカルまたはリモートの CSV データセットに基づいて Vizro スタイルの plotly チャートを作成します。
開発者の場合、またはVizro-MCPをソースから実行している場合は、Vizroリポジトリをクローンする必要があります。Vizro-MCPは、 uvとdocker 2つの構成オプションをサポートしています。
uvを使用した設定Vizro-MCP サーバーの詳細を構成するには:
Claude の場合:開発者設定で見つかったclaude_desktop_config.jsonに以下を追加します。
カーソルの場合:カーソル設定で見つかったmcp.jsonに以下を追加します。
{
"mcpServers": {
"vizro-mcp": {
"command": "uv",
"args": [
"run",
"--directory",
"<PATH TO VIZRO>/vizro-mcp/",
"vizro-mcp"
]
}
}
}<PATH TO VIZRO>をVizroリポジトリへの実際のパスに置き換えてください。uv実行ファイルへのフルパスも指定する必要がある場合があります。 "uv" uv代わりに"/Users/<your-username>/.local/bin/uv"のようなパスを使用してください。お使いのマシン上のuvのパスを確認するには、ターミナルアプリでwhich uvと入力してください。
dockerを使った設定制御されたランタイム環境のために、Docker コンテナ内で Vizro-MCP を実行できます。
vizro-mcpディレクトリのルートで、次のコマンドを使用して Docker イメージをビルドします。
docker build -t vizro-mcp .設定ファイルに次の内容を追加します。
{
"mcpServers": {
"vizro-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"--mount",
"type=bind,src=</absolute/path/to/allowed/dir>,dst=</absolute/path/to/allowed/dir>",
"--mount",
"type=bind,src=</absolute/path/to/data.csv>,dst=</absolute/path/to/data.csv>",
"vizro-mcp"
]
}
}
}Vizro-MCPでローカルデータを使用するには、データディレクトリをコンテナにマウントしてください。 </absolute/path/to/allowed/dir>または</absolute/path/to/data.csv>を、マシン上のデータへの絶対パスに置き換えてください。一貫性を保つため、 dstパスはsrcパスと一致させることをお勧めします。
ユーザーは、ホスト LLM アプリケーションを介して実行されるすべての操作に対して責任を負います。
ユーザーは、サードパーティ製の AI 生成ツールにアクセスするために必要なすべての権利を取得し、適用されるすべての利用規約を遵守する責任を負います。
ユーザーは、サードパーティ製の AI 生成ツールおよび Vizro の使用とセキュリティについて全責任を負います。
ユーザーは以下を承認し、同意するものとします。
サードパーティの生成 AI ツール (以下「GenAI ツール」) によって生成された結果、オプション、データ、推奨事項、分析、コード、その他の情報 (以下「出力」) には、誤り、差別、誤解を招く可能性のある、不正確な情報、偏見、違法な情報、著作権を侵害する可能性のある情報、またはその他の不適切なコンテンツが含まれている場合があります。
マッキンゼー・アンド・カンパニー：
（i）出力の正確性、妥当性、適時性、信頼性、商品性、特定目的への適合性、非侵害性、安全性または完全性について明示的に否認します。
（ii）当該出力における誤り、脱落、その他の欠陥、遅延、中断、またはそれに基づいて行われたいかなる行為についても責任を負わないものとし、
(iii) ユーザーによる GenAI ツールおよび出力の使用に起因する、第三者の権利の違反または侵害の疑いがある場合でも、一切の責任を負いません。
出力はユーザーによって検証および検証され、人間による監視なしに使用されることはなく、個人に影響を与える意思決定の唯一の根拠として使用されてはなりません。
ユーザーは、出力の使用について単独で責任を負います。特に、ユーザーは、コンテキストとユースケースを考慮して必要な人間による監視レベルを決定する必要があり、また、ユーザーの担当者および影響を受ける他のユーザーにGenAI出力の性質について通知する必要があります。ユーザーはまた、自身の決定、行動、VizroおよびVizro-MCPの使用、および適用される法律、規則、規制の遵守についても全責任を負います。これには、出力が第三者の権利を侵害していないことを確認することが含まれますが、これに限定されません。
Vizro-MCPは、大規模言語モデル（LLM）がAI分野における大きな進歩を象徴しているため、生成AIモデルで使用されています。しかし、他の強力なツールと同様に、生成AIモデルへの接続には潜在的なリスクが伴います。
Vizro-MCP を使用する前に、選択したモデルを調査して理解することをお勧めします。
ユーザーは、AI 生成コンテンツを補足として扱い、常に人間の判断を適用し、注意してアプローチし、関連する免責事項ページを確認し、以下の点を考慮することが推奨されます。
ベンダーモデルには、最新の更新以降のリアルタイムの知識やイベントが不足している可能性があります。Vizro-MCPの出力は変動する可能性があるため、重要な情報は常に検証する必要があります。生成されたコンテンツの正確性、一貫性、信頼性を判断するのはユーザーの責任です。
Get the JSON schema for the specified Vizro model. Server Vizro version: 0.1.62
| Name | Required | Description | Default |
|---|---|---|---|
| model_name | Yes | Name of the Vizro model to get schema for (e.g., 'Card', 'Dashboard', 'Page') |
| Name | Required | Description |
|---|---|---|
| model_name | Yes | |
| json_schema | Yes | |
| additional_info | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It adds the useful server-version context ('Server Vizro version: 0.1.62'), which is genuinely beyond structured fields. However, it doesn't disclose whether this is a pure read (implied by 'Get' but not declared), whether it errors on unknown model names, or what the returned schema covers.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short clauses, front-loaded with the purpose and followed by version context. The trailing version sentence is useful but slightly clipped in phrasing, keeping it just under a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Output schema exists, so the description needn't explain return values, and the single param is well documented. Missing only when-to-use guidance and any failure-mode context for an invalid model_name.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the parameter's own description ('Name of the Vizro model to get schema for', with examples 'Card', 'Dashboard', 'Page') fully documents it. The tool description adds no additional parameter meaning; baseline 3 is correct.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Get) and resource (JSON schema for a Vizro model), and names the server version, which is a distinguishing detail. No sibling tool shares this purpose, so an agent can route to it unambiguously.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies this is used to obtain a schema for a named model, but gives no explicit when-to-use, prerequisites, or alternatives relative to siblings like validate_dashboard_config. Usage is only inferable from the verb+resource.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
If user provides no data, use this tool to get sample data information.
Use the following data for the below purposes:
- iris: mostly numerical with one categorical column, good for scatter, histogram, boxplot, etc.
- tips: contains mix of numerical and categorical columns, good for bar, pie, etc.
- stocks: stock prices, good for line, scatter, generally things that change over time
- gapminder: demographic data, good for line, scatter, generally things with maps or many categories
Returns:
Data info object containing information about the dataset.
| Name | Required | Description | Default |
|---|---|---|---|
| data_name | Yes | Name of the dataset to get sample data for |
| Name | Required | Description |
|---|---|---|
| file_name | Yes | |
| file_path_or_url | Yes | |
| column_names_types | No | |
| file_location_type | Yes | |
| read_function_string | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations present, so description bears full burden. It discloses return type ('Data info object') and implies read-only behavior, but lacks details on permissions, rate limits, or side effects. Adequate for a simple retrieval tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with a bullet list for dataset descriptions. Condition ('If user provides no data') is front-loaded. Slightly verbose but every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the existence of an output schema (not shown), description correctly focuses on input semantics and use case. It adequately covers the tool's role among siblings, which handle user-provided data or code validation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% (single parameter with enum). Description adds significant meaning beyond schema by explaining each dataset's suitability for different visualizations (e.g., 'iris: mostly numerical... good for scatter, histogram').
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: to get sample data information when no data is provided. It lists four specific datasets (iris, tips, stocks, gapminder) and their characteristics, distinguishing it from sibling tools that handle user-provided data or schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use ('If user provides no data'). Provides guidance on dataset selection based on chart types (scatter, bar, line, etc.). Does not explicitly exclude alternatives but usage condition is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get instructions for creating a Vizro chart or dashboard. Call FIRST when asked to create Vizro things.
Must be ALWAYS called FIRST with advanced_mode=False, then call again with advanced_mode=True
if the JSON config does not suffice anymore.
Returns:
Instructions for creating a Vizro chart or dashboard
| Name | Required | Description | Default |
|---|---|---|---|
| user_host | Yes | The host the user is using, if 'ide' you can use the IDE/editor to run python code | |
| user_plan | Yes | The type of Vizro thing the user wants to create | |
| advanced_mode | No | Only call if you need to use custom CSS, custom components or custom actions. No need to call this with advanced_mode=True if you need advanced charts, use `custom_charts` in the `validate_dashboard_config` tool instead. |
| Name | Required | Description |
|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, but description explains the two-step calling behavior and the nature of the return (instructions). Some details like auth or rate limits are absent, but the core behavior is clear.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Very concise, front-loaded with purpose, uses bullet points for clarity, every sentence adds value without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With output schema present and all parameters described, the description covers the needed context for using the tool correctly, including the call sequence.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and description adds valuable context for advanced_mode parameter, explaining when to use it. This goes beyond what the schema alone provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Get instructions for creating a Vizro chart or dashboard' and specifies it should be called first, making the purpose unambiguous and distinct from sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance: 'Must be ALWAYS called FIRST with advanced_mode=False, then call again with advanced_mode=True if the JSON config does not suffice anymore.' This tells when to use and how to iterate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Use to understand local or remote data files. Must be called with absolute paths or URLs.
Supported formats:
- CSV (.csv)
- JSON (.json)
- HTML (.html, .htm)
- Excel (.xls, .xlsx)
- OpenDocument Spreadsheet (.ods)
- Parquet (.parquet)
Returns:
DataAnalysisResults object containing DataFrame information and metadata
| Name | Required | Description | Default |
|---|---|---|---|
| path_or_url | Yes | Absolute (important!) local file path or URL to a data file |
| Name | Required | Description |
|---|---|---|
| valid | Yes | |
| df_info | Yes | |
| message | Yes | |
| df_metadata | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully bears the burden of behavioral disclosure. It states the action (load and analyze), supported formats, and return type, but does not disclose whether the operation is read-only, potential file size/performance implications, or any side effects. This is adequate but could be more thorough.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise: three lines covering purpose, requirement, formats, and return type. It is front-loaded with the main purpose and includes no redundant information. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simplicity of the tool (one parameter, output schema exists), the description covers the essential aspects: purpose, required input format, supported file types, and return type. It may lack details about remote access authentication or error handling, but overall it is sufficiently complete for an agent to use the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage for the single parameter (path_or_url) with a good description. The additional description adds critical usage constraints (absolute paths/URLs) and lists supported file formats, which significantly enhances the parameter semantics beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the tool is used to 'understand local or remote data files' and specifies supported formats and return type. While the verb 'understand' is somewhat vague, the combination with the tool name and listed formats makes the purpose clear. It is distinguishable from sibling tools that handle schema, validation, and chart planning.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description includes the critical usage constraint 'Must be called with absolute paths or URLs' but provides no explicit guidance on when to use this tool versus alternatives. The siblings are clearly different in function, so it's implicitly appropriate for data loading, but a brief comparison would improve clarity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Validate the chart code created by the user and optionally open the PyCafe link in a browser.
Returns:
ValidationResults object with status and dashboard details
| Name | Required | Description | Default |
|---|---|---|---|
| auto_open | No | Whether to automatically open the PyCafe link in a browser | |
| data_info | Yes | Metadata for the dataset to be used in the chart | |
| chart_config | Yes | A ChartPlan object with the chart configuration |
| Name | Required | Description |
|---|---|---|
| valid | Yes | |
| message | Yes | |
| pycafe_url | Yes | |
| python_code | Yes | |
| browser_opened | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behavior. It only states validation and optional browser opening, but omits details like whether code is executed, what constitutes invalid code, side effects, or authentication requirements. The return type is mentioned but not elaborated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very concise with two sentences plus a return note. It front-loads the primary action. However, it could slightly expand on key behaviors without losing conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having an output schema (mentioned), the description lacks context about when validation is needed, error handling, or workflow integration with sibling tools. It omits important contextual details for an effective agent invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage with detailed descriptions for all parameters, including nested objects. The tool description adds no extra meaning beyond the schema, so it scores the baseline of 3. It does not clarify how parameters relate to validation logic.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool validates chart code and optionally opens a PyCafe link in a browser. It uses a specific verb ('Validate') and resource ('chart code'), and the purpose is distinct from sibling tools like 'get_vizro_chart_or_dashboard_plan' and 'validate_dashboard_config'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives, nor does it mention prerequisites, exclusions, or context. It fails to differentiate usage scenarios among sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Validate Vizro model configuration. Run ALWAYS when you have a complete dashboard configuration.
If successful, the tool will return the python code and, if it is a remote file, the py.cafe link to the chart.
The PyCafe link will be automatically opened in your default browser if auto_open is True.
Returns:
ValidationResults object with status and dashboard details
| Name | Required | Description | Default |
|---|---|---|---|
| auto_open | No | Whether to automatically open the PyCafe link in a browser | |
| data_infos | Yes | List of DFMetaData objects containing information about the data files | |
| custom_charts | Yes | List of ChartPlan objects containing information about the custom charts in the dashboard | |
| dashboard_config | Yes | Either a JSON string or a dictionary representing a Vizro dashboard model configuration |
| Name | Required | Description |
|---|---|---|
| valid | Yes | |
| message | Yes | |
| pycafe_url | Yes | |
| python_code | Yes | |
| browser_opened | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It discloses success outputs (Python code, py.cafe link, auto-open behavior) and mentions return type. However, it does not explain what validation entails (syntax checks, data consistency), leaving process details ambiguous.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is brief (two sentences plus a return line) and front-loads the primary purpose. It avoids unnecessary details, though the second paragraph could be considered an aside. It is appropriately sized for a tool with a comprehensive schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity (nested objects, output schema implied), the description mentions return behavior and auto-open but lacks details on validation scope (e.g., what checks are performed, prerequisites). Output schema existence reduces the need to explain return values, but process details are missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description only adds value by noting the auto_open parameter's effect and the return type, which is marginal. It does not elaborate on the required parameters beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states 'Validate Vizro model configuration' with a clear verb and resource. It differentiates from siblings like 'validate_chart_code' which focuses on individual charts, making the tool's purpose distinct.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description advises 'Run ALWAYS when you have a complete dashboard configuration', providing strong contextual guidance. While it doesn't explicitly exclude other scenarios, the sibling tools cover individual parts (e.g., chart validation, data loading), implying this is for full config validation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Scored across 6 tools
Most tools have distinct purposes (schema retrieval, sample data, planning, data loading, validation). The two validate_* tools overlap somewhat (chart code vs dashboard config), and get_model_json_schema vs get_vizro_chart_or_dashboard_plan could be confused, but descriptions clarify intent.
All six tools follow a consistent snake_case verb_noun pattern (get_*, load_*, validate_*). The long get_vizro_chart_or_dashboard_plan name is verbose but still follows the established convention.
Six tools is well-scoped for a Vizro dashboard-building helper. Each tool covers a distinct phase of the workflow (plan, schema, data, validate), so none feels redundant.
The surface covers the full authoring lifecycle: planning, schema lookup, data loading, and validation. A tool to render/serve the finished dashboard directly (beyond validation output) would close the last gap.
The grounded data layer for any LLM: governed SQL, metrics, lineage and catalog over your data.
Explore your databases, validate SQL, and build & publish data apps in your Mako workspace.
Generate answers & visualizations from your engineering data to track software development health.
Dashboards as data. Author, validate, render, and share dvt dashboards from any MCP client.
