Skip to main content
Glama
sharafutdinovdi

Revit Model MCP

Edit Families

revit_edit_families
Destructive

Edit open or named Revit families in place: add, remove, purge, or set shared parameters, with dry-run rollback and per-family load cycles.

Instructions

Edit an open family in place, or named project families (exact names or ["*"]), one load cycle each. A dry run rolls back all changes. A long action can return status=running and jobId when the wait budget expires; it may already have changed the model, and revit_jobs returns its result. Resubmitting repeats the action.

Input Schema

NameRequiredDescriptionDefault
dry_runNo
documentNoTitle or file name substring of the target open document; needed when several are open.
familiesNo
operationsYes
stop_on_errorNo
timeout_secondsNo
overwrite_parameter_valuesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed30 schema fields changedv0.10.0
    • removedInput schema / $defs / AddSharedParameters / properties / op / title
      Removed value: -"Op"
    • removedInput schema / $defs / AddSharedParameters / properties / parameters / title
      Removed value: -"Parameters"
    • removedInput schema / $defs / AddSharedParameters / properties / replace_family_parameter / title
      Removed value: -"Replace Family Parameter"
    • removedInput schema / $defs / AddSharedParameters / properties / shared_parameter_file / title
      Removed value: -"Shared Parameter File"
    • removedInput schema / $defs / AddSharedParameters / title
      Removed value: -"AddSharedParameters"
    • removedInput schema / $defs / Purge / properties / op / title
      Removed value: -"Op"
    • removedInput schema / $defs / Purge / title
      Removed value: -"Purge"
    • removedInput schema / $defs / RemoveParameters / properties / include_shared / title
      Removed value: -"Include Shared"
    • removedInput schema / $defs / RemoveParameters / properties / names / title
      Removed value: -"Names"
    • removedInput schema / $defs / RemoveParameters / properties / op / title
      Removed value: -"Op"
    • removedInput schema / $defs / RemoveParameters / title
      Removed value: -"RemoveParameters"
    • removedInput schema / $defs / SetShared / properties / op / title
      Removed value: -"Op"
    • removedInput schema / $defs / SetShared / properties / shared / title
      Removed value: -"Shared"
    • removedInput schema / $defs / SetShared / title
      Removed value: -"SetShared"
    • removedInput schema / $defs / SharedParameter / properties / group / title
      Removed value: -"Group"
    • removedInput schema / $defs / SharedParameter / properties / guid / title
      Removed value: -"Guid"
    • removedInput schema / $defs / SharedParameter / properties / instance / title
      Removed value: -"Instance"
    • removedInput schema / $defs / SharedParameter / properties / name / title
      Removed value: -"Name"
    • removedInput schema / $defs / SharedParameter / title
      Removed value: -"SharedParameter"
    • changedInput schema / properties / document / description
      Previous value: -"Case-insensitive substring of the target open document's title or file name. Required to disambiguate when the Revit process has more than one document open; omit only when a single document is open (the active document is used). An unknown or ambiguous reference is rejected before any change."New value: +"Title or file name substring of the target open document; needed when several are open."
    • removedInput schema / properties / document / title
      Removed value: -"Document"
    • removedInput schema / properties / dry_run / title
      Removed value: -"Dry Run"
    • removedInput schema / properties / families / title
      Removed value: -"Families"
    • removedInput schema / properties / operations / title
      Removed value: -"Operations"
    • removedInput schema / properties / overwrite_parameter_values / title
      Removed value: -"Overwrite Parameter Values"
    • removedInput schema / properties / response_timeout_s
      Removed value: -{
      -  "default": 1800,
      -  "maximum": 3600,
      -  "minimum": 30,
      -  "title": "Response Timeout S",
      -  "type": "integer"
      -}
    • removedInput schema / properties / stop_on_error / title
      Removed value: -"Stop On Error"
    • addedInput schema / properties / timeout_seconds
      Added value: +{
      +  "default": 1800,
      +  "maximum": 3600,
      +  "minimum": 30,
      +  "type": "integer"
      +}
    • removedInput schema / title
      Removed value: -"revit_edit_familiesArguments"
    • removedOutput schema / title
      Removed value: -"revit_edit_familiesDictOutput"
  2. Addedv0.7.0

TDQS

A3.6/5.0
Behavior5/5

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

Annotations only flag destructive=true and idempotent=false; the description goes substantially further by disclosing that a dry run rolls back all changes, that a long action can return status=running with a jobId while possibly having already mutated the model, that revit_jobs retrieves the finished result, and that resubmission repeats the action. That partial-application warning and the non-idempotency restatement are exactly the behavioral context an agent needs before firing a destructive batch.

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?

Three tight sentences with the scope statement front-loaded and zero filler. "one load cycle each" is slightly cryptic jargon and would benefit from a word of unpacking, but nothing is redundant.

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

Completeness3/5

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

An output schema exists, so return values need not be explained, and the async/jobId behavior is handled well. For a tool with four distinct operation types and seven parameters, though, the description leaves the entire operation vocabulary and the remaining five flags undocumented, which is thin for this complexity.

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

Parameters2/5

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

Schema description coverage is only 14% (one of seven parameters documented), so the description carries the burden and largely fails to pick it up. It explains the families wildcard convention and dry_run's semantics, but says nothing about operations (the op discriminator and its four variants), stop_on_error, timeout_seconds, overwrite_parameter_values, or document targeting.

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?

States a specific verb and resource ("Edit ... families") and distinguishes the two targeting modes: the currently open family edited in place versus named project families addressed by exact name or ["*"]. It does not, however, name or differentiate itself from near siblings such as revit_family_audit, revit_load_family, or revit_place_family, so the reader must infer the boundary.

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?

Usage is implied through the dry_run clause and the running/jobId handoff, but there is no explicit statement of when to choose this tool over alternatives (e.g. revit_update_parameters, revit_load_family) or what preconditions must hold. The families wildcard syntax is the only concrete targeting guidance offered.

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