Skip to main content
Glama
sharafutdinovdi

Revit Model MCP

Parameter Fill Check

revit_parameter_fill_check
Read-onlyIdempotent

Count filled, empty, and missing Revit parameters by category and scope before export or hand-over, with per-element samples and instance/type breakdown.

Instructions

Count filled, empty and missing parameters before an export or hand-over.

Returns data with scope, per-parameter and per-category counts, instance/type ownership, storage types and empty/missing element ID samples. No matching elements produce zero counts and empty samples; absent parameters count as missing, and numeric zero counts as filled. A missing document, invalid scope or timeout raises an error; partial data is not returned.

If more than one Revit instance is running, document is required; otherwise any instance may respond.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
viewNoExact non-template view name from the views catalog, matched case-insensitively, to restrict the element collector. Default null searches the document without a view filter; combines with the other model filters.
levelNo
worksetNo
documentNoCase-insensitive substring of the target active document title or file name; default null leaves requests unaddressed, so any instance may respond. Use a unique substring with multiple instances; revit_list_instances instead returns all matching instances, or all instances when omitted.
categoriesYesRequired list of 1-20 category names from the categories catalog; no default. Matches any listed category and combines with level, workset and view filters.
parametersYesRequired list of 1-30 exact localized parameter names; no default. Each name uses the first LookupParameter match, with type fallback controlled by include_types; missing names are counted as missing.
sample_limitNoMaximum element IDs sampled per parameter for each empty and missing list, an integer from 1 to 100. Default 20 limits samples only; all matching elements contribute to counts.
include_typesNo
timeout_secondsNoPositive integer seconds to wait for a result after pickup (120 when omitted); HTTP uses this as its response budget. Expiry raises an error, and increasing it does not override the add-in's execution limits.
pickup_timeout_secondsNoPositive integer seconds to wait for the add-in to pick up a local or SSH job (300 when omitted); ignored over HTTP. A pickup timeout raises an error but the pending job may still execute later.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.1.1
    • addedInput schema / properties / categories / description
      Added value: +"Required list of 1-20 category names from the categories catalog; no default. Matches any listed category and combines with level, workset and view filters."
    • addedInput schema / properties / document / description
      Added value: +"Case-insensitive substring of the target active document title or file name; default null leaves requests unaddressed, so any instance may respond. Use a unique substring with multiple instances; revit_list_instances instead returns all matching instances, or all instances when omitted."
    • addedInput schema / properties / parameters / description
      Added value: +"Required list of 1-30 exact localized parameter names; no default. Each name uses the first LookupParameter match, with type fallback controlled by include_types; missing names are counted as missing."
    • addedInput schema / properties / pickup_timeout_seconds / description
      Added value: +"Positive integer seconds to wait for the add-in to pick up a local or SSH job (300 when omitted); ignored over HTTP. A pickup timeout raises an error but the pending job may still execute later."
    • addedInput schema / properties / sample_limit / description
      Added value: +"Maximum element IDs sampled per parameter for each empty and missing list, an integer from 1 to 100. Default 20 limits samples only; all matching elements contribute to counts."
    • addedInput schema / properties / timeout_seconds / description
      Added value: +"Positive integer seconds to wait for a result after pickup (120 when omitted); HTTP uses this as its response budget. Expiry raises an error, and increasing it does not override the add-in's execution limits."
    • addedInput schema / properties / view / description
      Added value: +"Exact non-template view name from the views catalog, matched case-insensitively, to restrict the element collector. Default null searches the document without a view filter; combines with the other model filters."
  2. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnlyHint and idempotentHint annotations, the description discloses important behaviors: no matching elements yield zero counts and empty samples, absent parameters count as missing, numeric zero counts as filled, invalid scope or timeout raises an error, partial data is never returned, and multi-instance routing requirements. This is rich behavioral context that annotations alone do not supply.

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 compact, well-organized, and front-loaded with the purpose. Every sentence earns its place: purpose, return data, edge cases, error behavior, and multi-instance routing. There is no fluff or repetition of schema content.

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

Completeness5/5

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

For a read-only analysis tool with an output schema and strong annotations, the description is complete. It covers scope, return data types, edge cases, error behavior, timeout behavior, and multi-instance selection. An agent has enough context to select and invoke this tool correctly without needing to inspect the output schema.

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

Parameters4/5

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

Schema coverage is 70%, and the schema already documents the most important parameters (view, document, categories, parameters, sample_limit, timeouts). The description adds semantic edge-case meaning around parameters and filters: absent parameters are counted as missing, numeric zero is treated as filled, and sample limits apply only to samples while counts remain complete. A few parameters like level, workset, and include_types rely on their names and titles, but the overall parameter meaning is clear.

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 opens with a specific verb-resource pair: 'Count filled, empty and missing parameters before an export or hand-over.' This clearly identifies the tool's unique function and distinguishes it from sibling tools such as revit_query_elements, revit_view_summary, or revit_model_health.

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

Usage Guidelines4/5

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

The description gives an explicit use context: 'before an export or hand-over.' It also provides practical routing guidance for multi-instance scenarios ('document is required; otherwise any instance may respond'). It does not explicitly name alternative sibling tools or exclusion conditions, so it misses the full when-not-to-use guidance.

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