Skip to main content
Glama
sharafutdinovdi

Revit Model MCP

Read Schedule Data

revit_schedule_data
Read-onlyIdempotent

Read Revit schedule header and body cell text with paging to extract displayed rows; check skipped lists and skippedCount when results are incomplete.

Instructions

Read displayed schedule header and body cell text, with paging. A non-empty skipped list means the result is incomplete; skippedCount counts all skipped entries.

Input Schema

NameRequiredDescriptionDefault
offsetNo
documentNoTitle or file name substring of the target document; needed when several Revit instances run.
max_rowsNo
scheduleYesExact schedule name or decimal Revit view ID.
process_idNoRevit process ID; takes precedence over document.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 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"
    • removedInput schema / properties / max_rows / title
      Removed value: -"Max Rows"
    • removedInput schema / properties / offset / title
      Removed value: -"Offset"
    • 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 / schedule / title
      Removed value: -"Schedule"
    • removedInput schema / title
      Removed value: -"revit_schedule_dataArguments"
    • removedOutput schema / title
      Removed value: -"revit_schedule_dataDictOutput"
  2. Addedv0.9.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description goes further by disclosing that results can be partial: a non-empty skipped list means incompleteness and skippedCount aggregates all skipped entries. That is genuinely useful context an agent needs to interpret the response, though it says nothing about rate limits or how paging interacts with mutation of the underlying schedule.

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?

Two tight sentences with no filler. The core action leads, and the incomplete-result caveat follows immediately, so the most decision-relevant information is front-loaded.

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?

With an output schema present, return structure need not be re-explained, yet the description usefully annotates the skipped/skippedCount semantics. Identification of the target schedule and document/process resolution are left to the schema, which is acceptable; nothing essential for correct invocation is missing.

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 coverage is 60%; document and process_id carry their own descriptions (including precedence), but offset and max_rows have no schema descriptions at all. The phrase 'with paging' acknowledges that paging exists without explaining offset/max_rows semantics, so the description only partially compensates for the 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?

States a specific verb and resource: reading header and body cell text of a schedule, plus the paging nature of the read. It is distinguishable from siblings like revit_create_schedule, revit_view_summary, or revit_query_elements, though it never names or contrasts with any of them explicitly.

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 only implied by the word 'displayed' (read what the schedule currently shows) and by the paging note. There is no statement of when to prefer this over sibling reads such as revit_view_info or revit_query_elements, and no exclusions or prerequisites are 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