get_revit_view
Exports a named Revit model view as a PNG image so AI clients can inspect and visualize BIM views.
Instructions
Exports a named model view as a PNG image.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view_name | Yes |
Exports a named Revit model view as a PNG image so AI clients can inspect and visualize BIM views.
Exports a named model view as a PNG image.
| Name | Required | Description | Default |
|---|---|---|---|
| view_name | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds the useful behavioral detail that the output is a PNG image, but it does not disclose where the image is written or returned.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single compact sentence with the action and output format front-loaded. There is no filler or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple and its annotations cover safety, but with no output schema the description should say what the PNG export returns or where it is saved. It also lacks guidance on obtaining valid view names, leaving a meaningful gap for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must carry the burden for the single view_name parameter. It only implies that the parameter is a view name; it does not explain the expected format or how to discover valid names (e.g., via list_revit_views).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Exports') and names the resource ('a named model view') plus the output format (PNG image). It is clear enough to distinguish an image export from list_revit_views or get_current_view_info, though it does not explicitly name those siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description states what the tool does but gives no guidance on when to use it versus alternatives like list_revit_views or get_current_view_info. It also omits prerequisites such as whether the view must already be open or active.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.