MCP

Connect Cursor or Claude to your BlockForm account so they can read and update reports. Most inspectors can skip this.

Before you start

You need a BlockForm account. OAuth sign-in (Google, Microsoft, or email) is the usual path. You can also create a bfi_ API key in Global Settings → API if your client sends Bearer headers. The same REST API is documented on the Public API page. The MCP server runs remotely (a Cloudflare Worker) and calls that API for you.

Endpoint

Production MCP endpoint: https://mcp.blockforminspection.com/mcp

Connect

  1. Add the remote server
    In Cursor, add a remote MCP server with the production URL. A typical mcpServers entry looks like this:
    {
      "mcpServers": {
        "blockform": {
          "url": "https://mcp.blockforminspection.com/mcp"
        }
      }
    }
  2. Complete OAuthSign in on the BlockForm consent screen with Google, Microsoft, or email. After consent, the Worker stores a BlockForm API key and uses it for later tool calls.
  3. Claude and other clientsUse the same URL and complete browser consent. Any MCP client that supports remote OAuth can connect this way.

Authentication

OAuth consent is the preferred path. If your client supports custom headers instead of OAuth, create a key in Global Settings → API and send Authorization: Bearer bfi_… to /mcp.

Tool calls use the same account catalogs and rate limits as the public API (30 requests per minute and 600 per hour). See the Public API page for error shapes and over-limit responses.

Available tools

Clients discover full argument schemas from the server. Request and response payloads match /api/v1; see the Public API page for REST details.

Reports

Create and manage inspection reports.

  • list_reportsList inspection reports
  • get_reportGet a report by id
  • create_reportCreate a report
  • update_report_headerMerge report header / editorData / statuses
  • delete_reportDelete a report

Blocks & notes

Edit report structure, inspection notes, evaluation procedures, and AI analysis.

  • list_report_blocksList report blocks
  • update_report_blockPatch a report block by key
  • add_report_sub_blockAdd a sub-block under a parent
  • reorder_report_blocksReorder report blocks
  • delete_report_blockDelete a report block
  • set_report_inspection_notesSet inspection notes on a part block
  • set_evaluation_proceduresLink evaluation procedures and notes on a part
  • generate_evaluation_procedure_notesAI-generate inspection notes for a part's evaluation procedures
  • generate_part_analysisGenerate analysis for a report block

Models

List stored CAD, schematic, and BOM objects, then attach them to a report.

  • list_modelsList stored CAD / schematic / BOM objects
  • attach_model_to_reportAttach uploaded model keys to a report. Upload files with POST /api/v1/models (MCP is a poor channel for multi-MB STEP files).

Parts & tags

Work with the Parts Library, photo guides, identity fields, and tags.

  • list_partsList Parts Library
  • create_partCreate a library part
  • update_partUpdate a library part including OEM/MFR/customer identity and photo guide
  • delete_partDelete a library part
  • set_part_photo_guideSet per-part photo guide instructions
  • generate_part_identityAI-fill part name, OEM, manufacturer, and customer fields
  • list_tagsList tags
  • create_tagCreate a tag
  • update_tagUpdate a tag
  • set_part_tagsReplace tag ids on a part

Catalogs

List, create, and update manufacturers, OEMs, inspection procedures, repair codes, customers, and vendors.

  • list_manufacturersList manufacturers
  • create_manufacturerCreate manufacturers item
  • update_manufacturerUpdate manufacturers item
  • list_oemsList oems
  • create_oemCreate oems item
  • update_oemUpdate oems item
  • list_inspection_proceduresList inspection-procedures
  • create_inspection_procedureCreate inspection-procedures item
  • update_inspection_procedureUpdate inspection-procedures item
  • list_repair_codesList repair-codes
  • create_repair_codeCreate repair-codes item
  • update_repair_codeUpdate repair-codes item
  • list_customersList customers
  • create_customerCreate customers item
  • update_customerUpdate customers item
  • list_vendorsList vendors
  • create_vendorCreate vendors item
  • update_vendorUpdate vendors item
  • generate_catalog_procedure_notesAI-draft catalog evaluation procedure notes

Settings & AI

Read and patch report settings, branding pointers, and AI helper prompts.

  • get_report_settingsGet report format, appearance, and company branding settings
  • update_report_settingsPatch report settings
  • upload_company_logoCompany logo upload is multipart REST only: POST /api/v1/report-settings/logo
  • upload_company_badgeCompany badge upload is multipart REST only: POST /api/v1/report-settings/badge
  • get_ai_promptsRead AI helper prompts
  • update_ai_promptPatch AI helper prompts

Limits & when to use REST

  • Upload large STEP, GLB, and similar files with REST POST /api/v1/models, then call attach_model_to_report.
  • Company logo and badge uploads are multipart REST only (POST /api/v1/report-settings/logo and POST /api/v1/report-settings/badge). The upload_company_logo and upload_company_badge tools return a pointer; they do not upload files.
  • Prefer REST for bulk or binary work. Use MCP for conversational report, parts, and catalog tasks.

Example workflows

Inspection notes

List reports, open one, then set inspection notes on a part:

List my inspection reports, open the most recent one, and set inspection notes on the first part block: "Wear on the mating face is within reuse limits."

Library part

Create a library part, assign tags, and fill identity fields:

Create a library part for PN-4412, tag it as rotating equipment, then generate OEM, manufacturer, and customer identity for it.

Model and procedures

Attach an already-uploaded model, then generate evaluation procedure notes:

List stored models, attach the latest STEP file to report <id>, then generate evaluation procedure notes for that report.

Troubleshooting

  • The URL must end with /mcp: https://mcp.blockforminspection.com/mcp.
  • If tools return not authenticated, reconnect the MCP server and complete OAuth again.
  • If the client cannot set Bearer headers, use OAuth instead of an API key.
  • 401 and 429 responses behave like the public API. Create or revoke keys in Global Settings → API; payload and rate-limit details are on the Public API page.