create_sheets
Automate the creation of numbered and named sheets in Revit, add specified views, and define title block types using JSON-RPC 2.0 for streamlined project documentation.
Instructions
批量创建图纸并添加指定视图,遵循JSON-RPC 2.0规范。
特性:
支持批量创建带编号和名称的图纸
可指定标题块类型
支持在图纸上添加视图
完善的参数验证和错误处理
参数: ctx (Context): FastMCP上下文对象 method (str): JSON-RPC方法名,默认为"CreateSheets" params (List[Dict]): 参数列表,每个字典包含: - number (str): 图纸编号(必填) - name (str): 图纸名称(必填) - titleBlockType (str): 标题块类型名称(必填) - viewName (str, optional): 要添加到图纸的视图名称(可选)
返回: dict: JSON-RPC 2.0格式的响应,结构为: 成功时: { "jsonrpc": "2.0", "result": [ { "elementId": "图纸/视口元素ID", "name": "元素名称", "familyName": "族名称" }, ... ], "id": request_id } 失败时: { "jsonrpc": "2.0", "error": { "code": int, "message": str, "data": any }, "id": request_id }
示例: response = create_sheets(ctx, params=[ { "number": "101", "name": "首层平面图", "titleBlockType": "A0 公制", "viewName": "标高 1" }, { "number": "102", "name": "二层平面图", "titleBlockType": "A0 公制" } ])
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method | No | CreateSheets | |
| params | No |
Implementation Reference
- xml_revit_mcp/server.py:41-44 (registration)The tool 'create_sheets' is included in the ARCHITECTURAL_TOOLS list, which groups architectural creation tools for registration to the MCP server.ARCHITECTURAL_TOOLS = [ create_levels, create_floor_plan_views, create_grids, create_walls, create_floors, create_door_windows, create_rooms, create_room_tags, create_family_instances, create_sheets ]
- xml_revit_mcp/server.py:134-147 (registration)The register_tools function iterates over ARCHITECTURAL_TOOLS (including create_sheets) and registers each tool function to the MCP server using the server.tool() decorator.def register_tools(server: FastMCP) -> None: """注册所有工具到MCP服务器""" # 注册建筑工具 for tool in ARCHITECTURAL_TOOLS: server.tool()(tool) # 注册MEP工具 for tool in MEP_TOOLS: server.tool()(tool) # 注册通用工具 for tool in GENERAL_TOOLS: server.tool()(tool)
- xml_revit_mcp/prompts.py:11-72 (helper)Documentation in asset_creation_strategy prompt mentions create_sheets() as step for creating sheets after rooms and tags.def asset_creation_strategy() -> str: """定义在Revit中创建资产的首选策略""" return """创建Revit模型元素时,请遵循以下策略和最佳实践: 0. 在创建任何元素前,优先检查当前项目状态: - 使用get_commands()获取所有可用功能 - 使用get_selected_elements()检查当前选中的元素 - 使用find_elements()查找特定类别的现有元素 1. 始终遵循正确的创建顺序: 1. 基础参考系统 - 使用create_levels()创建必要的标高 - 使用create_grids()创建轴网系统 - 使用create_floor_plan_views()为每个标高创建平面视图 2. 主体结构元素 - 使用create_walls()创建墙体,注意指定正确的起点、终点、高度和宽度 - 使用create_floors()创建楼板,确保边界点形成封闭环路 3. 二次构件 - 使用create_door_windows()在墙体上创建门窗 注意:门窗族需要指定宿主墙,所以必须先有墙再创建门窗 - 使用get_locations()获取墙体的位置信息,以便正确放置门窗 4. MEP系统 - 使用create_ducts()创建风管 - 使用create_pipes()创建管道 - 使用create_cable_trays()创建电缆桥架 5. 内部划分和标注 - 使用create_rooms()在封闭区域创建房间 - 使用create_room_tags()添加房间标签 6. 文档整理 - 使用create_sheets()创建图纸 - 使用active_view()切换到需要的视图 - 使用link_dwg_and_activate_view()链接DWG图纸 2. 操作现有元素时的最佳实践: - 使用parameter_elements()获取元素参数,然后使用update_elements()修改 - 使用move_elements()调整元素位置 - 使用show_elements()在视图中高亮显示特定元素 - 使用delete_elements()移除不需要的元素 3. 创建复杂组件时: - 使用create_family_instances()创建参数化族实例 - 对于未预定义的功能,使用call_func()调用特定功能 4. 所有元素创建后的检查与验证: - 检查元素参数是否符合要求 - 确保结构完整性和空间关系合理性 - 使用show_elements()检查关键元素 - 使用active_view()切换到需要的视图 仅在以下情况使用原生RevitAPI: - 上述函数不能满足特定需求 - 需要创建自定义参数或复杂约束 - 需要进行高级计算或特殊几何操作 - 需要与其他应用程序进行数据交换 - 如果获取BuiltInCategory失败可以通过get_all_builtin_category查找 """
- tests/CreateSheets.py:21-28 (helper)Test file demonstrates calling the underlying Revit RPC method 'CreateSheets' with sheet data parameters, likely what the MCP tool handler would invoke.json_rpc_request = { "jsonrpc": "2.0", "method": "CreateSheets", "params": data, } # 发送更新元素数据 send_tcp_data(json_rpc_request)