Skip to main content
Glama
deenesjakoruzh
mckinsey

vizro-mcp

Official
by mckinsey
OverviewSchemaRelated ServersScoreDiscussions
Python
Hybrid

get_vizro_chart_or_dashboard_plan

Get step-by-step instructions for creating Vizro charts or dashboards. Start with basic configuration, then use advanced mode for custom CSS, components, or actions.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_planYesThe type of Vizro thing the user wants to create
user_hostYesThe host the user is using, if 'ide' you can use the IDE/editor to run python code
advanced_modeNoOnly 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.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • vizro-mcp/src/vizro_mcp/server.py:81-105 (handler)
    The core handler function for the 'get_vizro_chart_or_dashboard_plan' tool, decorated with @mcp.tool(). It returns specific instructions for chart or dashboard creation based on input parameters, delegating to imported utilities for the content.
    def get_vizro_chart_or_dashboard_plan(
    user_plan: Literal["chart", "dashboard"] = Field(description="The type of Vizro thing the user wants to create"),
    user_host: Literal["generic_host", "ide"] = Field(
        description="The host the user is using, if 'ide' you can use the IDE/editor to run python code"
    ),
    advanced_mode: bool = Field(
        default=False,
        description="""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.""",
    ),
) -> str:
    """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
    """
    if user_plan == "chart":
        return CHART_INSTRUCTIONS
    elif user_plan == "dashboard":
        return f"{get_dashboard_instructions(advanced_mode, user_host)}"

Tool Definition Quality

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes the tool's workflow (two-step calling pattern) and clarifies that it returns instructions rather than executing creation directly. However, it doesn't mention potential limitations like rate limits, authentication needs, or error conditions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized with three focused sentences that each serve a clear purpose: stating the tool's function, providing usage instructions, and describing the return value. It's front-loaded with the most important information (call first for creation tasks). One minor improvement could be combining the two advanced_mode sentences.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (so return values are documented elsewhere) and 100% schema coverage, the description provides good contextual completeness. It explains the tool's role in the workflow and when to use it versus alternatives. The main gap is lack of behavioral details like error handling or performance characteristics.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all three parameters thoroughly. The description adds minimal value beyond the schema - it mentions the advanced_mode parameter's purpose but doesn't provide additional semantic context about user_plan or user_host parameters. Baseline 3 is appropriate when schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Get instructions for creating') and resource ('Vizro chart or dashboard'), distinguishing it from sibling tools like validate_chart_code or validate_dashboard_config. It explicitly mentions it's for creating Vizro things, which sets it apart from data analysis or schema tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage instructions: 'Call FIRST when asked to create Vizro things' and specifies a two-step process with advanced_mode=False then True if needed. It also references an alternative tool (validate_dashboard_config) for advanced charts, offering clear when/when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mckinsey/vizro'

If you have feedback or need assistance with the MCP directory API, please join our Discord server