OpenForm
MCPTools

get_artifact

Last updated on

Get the full OpenForm artifact JSON and metadata

Get the full OpenForm artifact JSON and metadata. Fetches the artifact from its verified registry. Use registry_id and artifact_name from list_artifacts or search.

Parameters

ParameterTypeRequiredDescription
registry_idstringYesRegistry ID
artifact_namestringYesArtifact name

Response

FieldTypeDescription
registry_idstringRegistry ID
artifact_namestringArtifact name
artifactobjectThe full artifact JSON object (form, document, bundle, or checklist)
metadata.titlestringDisplay title
metadata.kindstringArtifact kind
metadata.descriptionstringArtifact description
metadata.registryobjectRegistry info: id, displayName, url, homepage
metadata.statsobjectInstall stats: installsTotal, installs24h, installs7d
errorstringError message if the artifact was not found or registry is not verified

Example

// Request
{
  "registry_id": "cly1abc123",
  "artifact_name": "lease-agreement"
}

// Response
{
  "registry_id": "cly1abc123",
  "artifact_name": "lease-agreement",
  "artifact": {
    "kind": "form",
    "title": "Lease Agreement",
    "schema": "2026-01-01",
    "fields": ["..."]
  },
  "metadata": {
    "title": "Lease Agreement",
    "kind": "form",
    "description": "Standard residential lease agreement",
    "registry": {
      "id": "cly1abc123",
      "displayName": "acme/legal-forms",
      "url": "https://example.com/registry",
      "homepage": "https://example.com"
    },
    "stats": {
      "installsTotal": 1420,
      "installs24h": 58,
      "installs7d": 312
    }
  }
}

On this page