Skip to main content
Glama
mckinsey

vizro-mcp

Official
by mckinsey
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

get_model_json_schema

Retrieve the JSON schema for a specified Vizro model, such as Card, Dashboard, or Page, to validate configurations and support app building.

Instructions

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

Input Schema

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

Output Schema

TableJSON 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.7/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 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.

Conciseness4/5

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.

Completeness4/5

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.

Parameters3/5

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.

Purpose5/5

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.

Usage Guidelines3/5

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.

Deploy Server

Other Tools