Fragment

Model Context Protocol (MCP) server for openBIM

typescript

32

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "helenkwok-openbim-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "/path/to/your/models/directory"
      ]
    }
  }
}

Fragment MCP Server provides tools to convert IFC files to the fragment format, load pre-converted fragments, and query BIM data by category. It is designed to streamline BIM data workflows by enabling efficient fragment-based querying and category-specific lookups.

How to use

You work with a client that talks to the Fragment MCP Server to convert IFC files, load those fragments, and fetch BIM elements by category. Start by converting IFC files to the fragment format, then load the resulting fragment file into memory, and finally query BIM elements by category such as walls, doors, or windows with configurable attributes and relations.

How to install

Prerequisites: you need Node.js installed and available on your command line.

Install dependencies with a package manager.

pnpm install

Run the server with the runtime command shown here.

node main.ts

Configuration and integration notes

Two MCP server configurations are shown for integration with Claude Desktop. These configurations enable a filesystem-based model store and a BIM server entry point.

{
  "mcpServers": {
    "filesystem": {
      "type": "stdio",
      "name": "filesystem",
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "/path/to/your/models/directory"
      ]
    },
    "bim": {
      "type": "stdio",
      "name": "bim",
      "command": "npx",
      "args": [
        "-y",
        "tsx",
        "/path/to/your/openbim-mcp/main.ts"
      ]
    }
  }
}

Usage workflow

Convert IFC to Fragment: Use the conversion tool to create a .frag file from an IFC file.
Load Fragments: Load the resulting .frag file into memory to prepare for querying.
Query Elements: Retrieve elements by category, such as walls, doors, or windows, with configurable attributes and relation data.

Supported IFC categories

Common categories you can query include walls, doors, windows, slabs, beams, columns, and spaces/rooms.

Available tools

convert-ifc-to-frag

Converts an IFC file to a .frag file for efficient processing.

load-frag

Loads a .frag file into memory for querying.

fetch-elements-of-category

Fetches elements of a specified IFC category from loaded fragments with configurable attributes and relations.