Model MCP

Overview Schema Source Related Servers Discussions Admin

Compare Link Datums

revit_compare_link_datums

Read-onlyIdempotent

Compare host grids and levels with a loaded Revit link to find missing or mismatched datums without changing the model; skipped items count as incomplete.

Instructions

Compare host grids and levels with one loaded Revit link. Changes nothing. skipped means incomplete; skippedCount is the total skipped.

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": {
      "link": "<link>"
    },
    "name": "revit_compare_link_datums"
  }
}

Input Schema

Name	Required	Description
`link`	Yes
`kinds`	No
`prefix`	No
`suffix`	No
`document`	No	Title or file name substring of the target document; needed when several Revit instances run.
`name_map`	No
`process_id`	No	Revit process ID; takes precedence over document.
`tolerance_mm`	No
`reuse_matching`	No
`level_offset_mm`	No
`timeout_seconds`	No	Seconds to wait for a result (default 120).

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv2.0.0Nov 3, 2026

removedInput schema / properties / pickup_timeout_seconds

Removed value: -{
-  "default": 300,
-  "description": "Seconds to wait for the add-in to pick up the job (default 300); unused over HTTP.",
-  "type": "integer"
-}

Changed18 schema fields changedv0.10.0Oct 14, 2026

changedInput schema / properties / document / description

Previous value: -"Case-insensitive substring of the target active document title or file name. Reads require exactly one matching instance; omitted document requires exactly one running instance. Zero or multiple matches fail before publishing. revit_list_instances returns all matching instances, or all running instances when omitted."New value: +"Title or file name substring of the target document; needed when several Revit instances run."

removedInput schema / properties / document / title
```
Removed value: -"Document"
```
removedInput schema / properties / kinds / title
```
Removed value: -"Kinds"
```
removedInput schema / properties / level_offset_mm / title
```
Removed value: -"Level Offset Mm"
```
removedInput schema / properties / link / title
```
Removed value: -"Link"
```
removedInput schema / properties / name_map / title
```
Removed value: -"Name Map"
```

changedInput schema / properties / pickup_timeout_seconds / description

Previous 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."New value: +"Seconds to wait for the add-in to pick up the job (default 300); unused over HTTP."

removedInput schema / properties / pickup_timeout_seconds / title
```
Removed value: -"Pickup Timeout Seconds"
```
removedInput schema / properties / prefix / title
```
Removed value: -"Prefix"
```

changedInput schema / properties / process_id / description

Previous value: -"Exact positive Revit process ID. Takes precedence over document; if both are supplied they must agree."New value: +"Revit process ID; takes precedence over document."

removedInput schema / properties / process_id / title
```
Removed value: -"Process Id"
```
removedInput schema / properties / reuse_matching / title
```
Removed value: -"Reuse Matching"
```
removedInput schema / properties / suffix / title
```
Removed value: -"Suffix"
```

changedInput schema / properties / timeout_seconds / description

Previous 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."New value: +"Seconds to wait for a result (default 120)."

removedInput schema / properties / timeout_seconds / title
```
Removed value: -"Timeout Seconds"
```
removedInput schema / properties / tolerance_mm / title
```
Removed value: -"Tolerance Mm"
```

removedInput schema / title

Removed value: -"revit_compare_link_datumsArguments"

removedOutput schema / title

Removed value: -"revit_compare_link_datumsDictOutput"

Addedv0.7.0Sep 30, 2026

TDQS

B3.1/5.0

Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, and "Changes nothing" merely restates that rather than adding new behavioral context. The one additive element is the note that "skipped means incomplete; skippedCount is the total skipped," but that is return-value semantics already covered by the existing output schema.

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 short sentences, front-loaded with the core action and free of filler. The final fragment ("skipped means incomplete; skippedCount is the total skipped") is telegraphic and would benefit from a clearer referent, but nothing is wasted.

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

Completeness2/5

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

For an 11-parameter tool with 27% schema coverage and no parameter hints, the description is far too thin — an agent cannot reasonably choose values for kinds, prefix/suffix, name_map, tolerance or level offset. The output schema lightens the burden on return values, but the input side remains largely undocumented.

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 27% across 11 parameters, and the description explains none of the undocumented ones: kinds, prefix, suffix, name_map, tolerance_mm, reuse_matching, and level_offset_mm are left with no guidance. Only link and the two documented document/process_id/timeout parameters have any semantics, so the description does not compensate for the coverage gap.

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?

"Compare host grids and levels with one loaded Revit link" names a specific verb (compare) and specific resources (grids, levels), and "Changes nothing" implicitly contrasts it with the mutating sibling revit_align_link_datums. It stops short of explicitly naming that alternative, so an agent 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?

The phrase "one loaded Revit link" implies a prerequisite (a single link must already be loaded) and the compare/align distinction is implied by "Changes nothing." There is no explicit when-to-use/when-not statement and no reference to revit_align_link_datums, which is the obvious alternative.

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

Deploy Server