Vizro-MCP — это сервер протокола контекста модели (MCP) , который работает совместно с LLM, помогая вам создавать панели мониторинга и диаграммы Vizro.
Vizro-MCP предоставляет инструменты и шаблоны для создания функционирующей диаграммы или панели Vizro шаг за шагом. Преимущества включают:
✅ Единая структура для диаграмм и панелей мониторинга с одним общим языком дизайна.
✅ Проверенные выходные данные конфигурации, которые легко читать и изменять или обслуживать.
✅ Предварительный просмотр панели инструментов в реальном времени для доработки дизайна до тех пор, пока панель инструментов не станет идеальной.
✅ Использование локальных или удаленных наборов данных путем простого указания пути или URL-адреса.
Без Vizro-MCP, если вы попытаетесь сделать панель управления с использованием LLM, он может выбрать любой фреймворк и использовать его без конкретных указаний, принципов дизайна или последовательности. Результаты таковы:
❌ Случайный выбор фреймворка фронтенда или библиотеки построения диаграмм.
❌ Беспорядок с виброкодом, который может работать, а может и нет, но определенно не очень пригоден для поддержки.
❌ Нет возможности легко просмотреть панель инструментов.
❌ Нет простого способа подключения к реальным данным.
Related MCP server: ML Research MCP
Если вы разработчик и вам нужны инструкции по запуску Vizro-MCP из исходного кода или запуску сервера из контейнера Docker, перейдите в конец этой страницы и перейдите к разделу Разработка или запуск из исходного кода .
Любое приложение LLM, поддерживающее MCP. Claude Desktop и Cursor — популярные варианты.
🐛 Примечание: в настоящее время известны некоторые проблемы с VS Code, но мы работаем над этим и надеемся, что Copilot скоро заработает.
⚠️ Предупреждение: в некоторых хостингах (например, Claude Desktop) бесплатный план может быть менее производительным, что может вызвать проблемы, если запрос слишком сложный. В случаях, когда запрос приводит к сбою пользовательского интерфейса, выберите платный план или уменьшите сложность запроса.
Общая конфигурация сервера в основном одинакова для всех хостов:
{
"mcpServers": {
"vizro-mcp": {
"command": "uvx",
"args": [
"vizro-mcp"
]
}
}
}В принципе, сервер Vizro MCP работает с любыми приложениями LLM с поддержкой MCP, но мы рекомендуем Claude Desktop или Cursor в качестве популярных вариантов (см. более подробные инструкции ниже). Различные инструменты ИИ могут использовать разные методы настройки или параметры подключения. Проверьте документацию каждого инструмента для получения подробной информации.
Добавьте следующее в файл 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 и просто отправить запрос. Это создаст очень простую панель мониторинга с одной страницей, одной диаграммой и одним фильтром. Продолжайте!
Вы также можете попросить LLM создать конкретные панели мониторинга на основе локальных или удаленных данных, если у вас уже есть представление о том, что вы хотите. Примеры подсказок могут быть такими:
Создайте панель мониторинга Vizro с одной страницей, диаграммой рассеивания и фильтром на основе данных
<insert absolute file path or public URL>.
Создайте простую двухстраничную панель мониторинга Vizro, где на первой странице будет представлен корреляционный анализ данных
<insert absolute file path or public URL>, а на второй странице будет представлена карта данных<insert absolute file path or public URL>.
Набор образцов CSV-файлов для тестирования можно найти в репозитории Plotly .
Вы даже можете запросить панель управления, не предоставляя данных:
Создайте панель мониторинга Vizro с одной страницей, диаграммой рассеяния и фильтром.
В общем случае полезно указать Vizro в приглашении и сделать его максимально точным (и простым).
Когда LLM выбирает использование инструмента validate_model_config и инструмент выполняется успешно, LLM возвращает ссылку на предварительный просмотр панели мониторинга в реальном времени, если используются только общедоступные данные, доступные через URL. По умолчанию 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 только локально, а не как размещенный сервер, поскольку в настоящее время отсутствует аутентификация для управления доступом.
Вторая наиболее важная часть — это инструмент validate_model_config . Этот инструмент попытается создать экземпляр конфигурации модели Vizro и вернуть код Python и ссылку визуализации для допустимых конфигураций. Если конфигурация допустима, он также вернет и попытается открыть ссылку на предварительный просмотр панели мониторинга в реальном времени, которая перенаправит вас в PyCafe . Если вы не хотите открывать ссылку, вы можете указать LLM не делать этого.
Сервер Vizro MCP предоставляет следующие инструменты. В общем случае вам не нужно использовать их напрямую, но в особых случаях вы можете попросить LLM вызвать их напрямую, чтобы помочь ему найти свой путь.
get_vizro_chart_or_dashboard_plan - Получите структурированный пошаговый план создания диаграммы или панели мониторинга. Предоставляет руководство по всему процессу создания.
get_model_JSON_schema — извлекает полную схему JSON для любой указанной модели Vizro, полезна для понимания обязательных и необязательных параметров.
validate_model_config — Тестирует конфигурации модели Vizro, пытаясь создать их экземпляр. Возвращает код Python и ссылки визуализации для допустимых конфигураций.
load_and_analyze_csv — загружает CSV-файл из локального пути или URL в pandas DataFrame и предоставляет подробный анализ его структуры и содержимого.
validate_chart_code — проверяет код, созданный для диаграммы, и возвращает отзыв о его корректности.
get_sample_data_info — предоставляет информацию о примерах наборов данных, которые можно использовать для тестирования и разработки.
create_starter_dashboard — используйте этот шаблон подсказок, чтобы начать работу с панелями мониторинга Vizro.
create_EDA_dashboard — используйте этот шаблон подсказки для создания панели разведочного анализа данных (EDA) на основе локального или удаленного набора данных CSV.
create_vizro_chart — используйте этот шаблон подсказки для создания диаграммы в стиле Vizro на основе локального или удаленного набора данных CSV.
Если вы разработчик или используете Vizro-MCP из исходников, вам необходимо клонировать репозиторий Vizro. Vizro-MCP поддерживает два варианта конфигурации: uv и docker .
uvЧтобы настроить параметры сервера Vizro-MCP:
Для Клода : добавьте следующее в файл 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" вы можете использовать что-то вроде "/Users/<your-username>/.local/bin/uv" . Чтобы узнать путь к uv на вашем компьютере, в вашем терминальном приложении введите which uv .
dockerВы можете запустить Vizro-MCP внутри контейнера Docker для создания контролируемой среды выполнения.
В корне каталога 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.
Пользователи несут ответственность за получение всех прав, необходимых для доступа к любым сторонним инструментам генеративного ИИ, а также за соблюдение любых применимых положений и условий.
Пользователи несут полную ответственность за использование и безопасность сторонних инструментов генеративного ИИ и Vizro.
Пользователи признают и соглашаются с тем, что:
Любые результаты, параметры, данные, рекомендации, анализы, код или другая информация («Результаты»), сгенерированные любыми сторонними инструментами генеративного ИИ («Инструменты GenAI»), могут содержать некоторые неточности, предвзятость, незаконный, потенциально нарушающий права или иным образом неприемлемый контент, который может быть ошибочным, дискриминационным или вводящим в заблуждение.
McKinsey & Company:
(i) прямо отказывается от точности, адекватности, своевременности, надежности, товарной пригодности, пригодности для определенной цели, отсутствия нарушений, безопасности или полноты любых Выходных данных,
(ii) не несет ответственности за любые ошибки, упущения или другие дефекты, задержки или прерывания в таких Выходных данных или за любые действия, предпринятые на их основе, и
(iii) не несет ответственности за любые предполагаемые нарушения или ущемления каких-либо прав третьих лиц в результате использования пользователями Инструментов GenAI и Выходных данных.
Выходные данные должны быть проверены и утверждены пользователями и не должны использоваться без человеческого контроля и в качестве единственной основы для принятия решений, влияющих на отдельных лиц.
Пользователи несут исключительную ответственность за использование Выходных данных, в частности, пользователям необходимо определить уровень человеческого контроля, необходимый для контекста и варианта использования, а также для информирования персонала пользователей и других затронутых пользователей о характере Выходных данных GenAI. Пользователи также несут полную ответственность за свои решения, действия, использование Vizro и Vizro-MCP и соблюдение применимых законов, правил и положений, включая, помимо прочего, подтверждение того, что Выходные данные не нарушают никаких прав третьих лиц.
Vizro-MCP используется генеративными моделями ИИ, поскольку большие языковые модели (LLM) представляют собой значительные достижения в области ИИ. Однако, как и в случае с любым мощным инструментом, существуют потенциальные риски, связанные с подключением к генеративной модели ИИ.
Мы рекомендуем пользователям изучить и понять выбранную модель перед использованием Vizro-MCP.
Пользователям рекомендуется относиться к контенту, созданному с помощью ИИ, как к дополнительному, всегда руководствоваться человеческим суждением, подходить к нему с осторожностью, просматривать соответствующую страницу с отказом от ответственности и учитывать следующее:
Модели поставщика могут не иметь знаний в реальном времени или событий за пределами последних обновлений. Вывод 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.
