Skip to main content
Glama
Sign In
Model MCP

Model MCP

by sharafutdinovdi
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

Check NWC Settings

revit_nwc_settings_check
Read-onlyIdempotent

Parse a Navisworks exporter XML file on the Revit workstation without exporting. skipped means incomplete; skippedCount is the total skipped.

Instructions

Parse a Navisworks exporter XML file on the Revit workstation without exporting. 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": {
      "settings_xml": "<settings_xml>"
    },
    "name": "revit_nwc_settings_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentNoTitle or file name substring of the target document; needed when several Revit instances run.
process_idNoRevit process ID; takes precedence over document.
settings_xmlYes
timeout_secondsNoSeconds to wait for a result (default 120).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • 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"
-}
  2. Changed11 schema fields changedv0.10.0
    • 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"
    • 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"
    • 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 / settings_xml / title
      Removed value: -"Settings Xml"
    • 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 / title
      Removed value: -"revit_nwc_settings_checkArguments"
    • removedOutput schema / title
      Removed value: -"revit_nwc_settings_checkDictOutput"
  3. Addedv0.7.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the description correctly builds on that by disclosing that the parsing happens on the Revit workstation with no export performed, and by clarifying the meaning of the returned 'skipped'/'skippedCount' fields. It omits permission requirements and what qualifies as an incomplete setting, but for a read-only inspection tool that is a modest gap.

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 sentences, front-loaded with the action and location, with the output-field gloss attached directly to what it clarifies. The second sentence is terse to the point of being cryptic ('skipped means incomplete'), but nothing is padding.

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?

The output schema covers return values and the annotations cover safety, so those needs are met. What is missing is the substance of the check itself: nothing explains which NWC settings are examined or what makes a setting 'incomplete', which is the core question an agent would have before invoking this tool.

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 75% and the two targeting parameters (document, process_id) plus timeout_seconds are already documented in the schema. The description's real contribution is identifying settings_xml as the Navisworks exporter XML file, the one required parameter the schema leaves undescribed, which resolves the most consequential ambiguity.

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 ('Parse a Navisworks exporter XML file') plus the operating location ('on the Revit workstation'), and the phrase 'without exporting' implicitly separates it from the export sibling revit_export_nwc. It never quite says what the 'check' validates, so the purpose lands as 'parse and report skipped items' rather than a crisp statement of the check being performed.

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?

There is only implicit routing: 'without exporting' hints that this is a pre-flight alternative to running revit_export_nwc, and 'on the Revit workstation' implies a live Revit connection is required. No explicit when-to-use, when-not-to-use, or named alternative is given.

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