Skip to main content
Glama
Sign In
vizro-mcp

vizro-mcp

Official
by mckinsey
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

get_model_json_schema

Retrieve the JSON schema for a specified Vizro model to validate configuration and inspect available fields when building or editing a visualization app.

Instructions

Get the JSON schema for the specified Vizro model. Server Vizro version: 1.0.0

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "model_name": "<model_name>"
    },
    "name": "get_model_json_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
model_nameYesName of the Vizro model to get schema for (e.g., 'Card', 'Dashboard', 'Page')

Output Schema

NameRequiredDescriptionDefault
model_nameYes
json_schemaYes
additional_infoYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.0
    • addedInput schema / properties / model_name / description
      Added value: +"Name of the Vizro model to get schema for (e.g., 'Card', 'Dashboard', 'Page')"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "additional_info": {
+      "title": "Additional Info",
+      "type": "string"
+    },
+    "json_schema": {
+      "additionalProperties": true,
+      "title": "Json Schema",
+      "type": "object"
+    },
+    "model_name": {
+      "title": "Model Name",
+      "type": "string"
+    }
+  },
+  "required": [
+    "model_name",
+    "json_schema",
+    "additional_info"
+  ],
+  "title": "ModelJsonSchemaResults",
+  "type": "object"
+}
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It usefully discloses the server Vizro version, which affects the returned schema, but it does not explicitly state that the operation is read-only, side-effect free, or what happens for an invalid model name.

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

Conciseness5/5

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

The description is two short sentences with no wasted text. It front-loads the purpose and appends useful version context in a compact form.

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?

For a simple one-parameter lookup with a fully documented schema and an output schema, the description is largely complete. The main omission is any explicit guidance about when the tool should be preferred over its siblings.

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 coverage is 100%, and the model_name parameter is already documented with examples such as 'Card', 'Dashboard', and 'Page'. The description adds no parameter details beyond what the schema provides, so the baseline of 3 applies.

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

Purpose4/5

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

The description states a specific verb and resource: retrieving the JSON schema for a named Vizro model. It is clear enough to distinguish this lookup tool from the validation, planning, and data-loading siblings. However, it does not explicitly contrast itself with those siblings.

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

Usage Guidelines3/5

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

The description implies usage for inspecting model schemas but gives no explicit when-to-use guidance, prerequisites, or alternatives. There is no mention of when not to use it or how it relates to validate_dashboard_config or get_vizro_chart_or_dashboard_plan.

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

Deploy Server

Other Tools