Revit MCP Server

Instructions

Implementation Reference

• src/tools/open_document.ts:12-39 (handler)

  Handler function that sends the 'open_document' command to the Revit client using the provided filePath parameter and returns the response or an error message.

  async (args, extra) => {
    const params = {
      filePath: args.filePath,
    };
  
    try {
      const response = await withRevitConnection(async (revitClient) => {
        return await revitClient.sendCommand('open_document', params);
      });
  
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(response, null, 2),
          },
        ],
      };
    } catch (error) {
      return {
        content: [
          {
            type: 'text',
            text: `document open failed: ${error instanceof Error ? error.message : String(error)}`,
          },
        ],
      };
    }

• src/tools/open_document.ts:9-11 (schema)

  Zod input schema defining an optional 'filePath' string parameter for the tool.

  {
    filePath: z.string().optional().describe('File Path'),
  },

• src/tools/open_document.ts:5-42 (registration)

  Registration of the 'open_document' tool via server.tool call within the registerOpenDocumentTool function, which is dynamically invoked during tool setup.

  export function registerOpenDocumentTool(server: McpServer) {
    server.tool(
      'open_document',
      'Open Document',
      {
        filePath: z.string().optional().describe('File Path'),
      },
      async (args, extra) => {
        const params = {
          filePath: args.filePath,
        };
  
        try {
          const response = await withRevitConnection(async (revitClient) => {
            return await revitClient.sendCommand('open_document', params);
          });
  
          return {
            content: [
              {
                type: 'text',
                text: JSON.stringify(response, null, 2),
              },
            ],
          };
        } catch (error) {
          return {
            content: [
              {
                type: 'text',
                text: `document open failed: ${error instanceof Error ? error.message : String(error)}`,
              },
            ],
          };
        }
      }
    );
  }