Skip to main content
The DataGalaxy app provides full read/write access to the DataGalaxy data catalog API. It can be used either as a Builder app (automations call DataGalaxy instructions directly) or as a remote MCP server consumed by an AI Knowledge agent.

Catalog Management

Sources, containers, structures, fields, glossary, usages, data processing

Links & Collaboration

Relationships, comments and tasks across any catalog entity

Dual Interface

Use as Builder app or MCP server exposed to agents

Prerequisites

  • A DataGalaxy account with API access
  • A Personal Access Token (PAT) or integration token
  • The DataGalaxy API base URL (default: https://api.datagalaxy.com)

Installation

  1. Go to Apps in your workspace
  2. Search for DataGalaxy and install it
  3. Open the app instance configuration and fill in the required fields

Configuration

FieldDescription
DataGalaxy API Base URLBase URL of the DataGalaxy API (default https://api.datagalaxy.com)
Authentication TokenPAT or integration token, stored as a workspace secret
MCP EndpointAuto-populated on install — URL of the MCP endpoint for this instance
MCP API KeyAuto-populated on install — signed key used in the mcp-api-key header. Do not modify
MCP Endpoint and MCP API Key are generated automatically by the onInstall flow and are only needed if you intend to expose this instance as an MCP server (see the next tab).

Available Instructions

Every instruction resolves credentials from the workspace configuration via buildAppAuth. Unless stated otherwise, all IDs use DataGalaxy’s DoubleUuid format and versionId refers to a workspace version ID returned by listVersions.

Search & Workspaces

InstructionArgumentsDescription
searchquery, versionId, limit, filtersSearch across all DataGalaxy objects by name, technical name, description or summary
listWorkspacesList all DataGalaxy workspaces accessible to the authenticated user
listVersionsworkspaceIdList all versions of a DataGalaxy workspace
listAttributesList all attributes (custom and built-in) defined in your DataGalaxy client space

Generic Object Operations

InstructionArgumentsDescription
getObjectversionId, objectIdGet details of any DataGalaxy object by its ID and version
updateObjectversionId, objectId, name, status, description, summary, owners, stewards, tags, technicalNameUpdate attributes of any DataGalaxy object
status accepts Proposed, InRevision, Validated, InValidation, Obsolete.

Sources

InstructionArguments
listSourcesversionId, limit, page, includeAttributes
getSourceversionId, sourceId
createSourceversionId, name, type, technicalName, description, summary, owners, stewards, tags, status
updateSourceversionId, sourceId, name, technicalName, description, summary, owners, stewards, tags, status
deleteSourceversionId, sourceId

Containers

InstructionArguments
listContainersversionId, parentId, limit, page, includeAttributes
getContainerversionId, containerId
createContainerversionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status
updateContainerversionId, containerId, name, technicalName, description, summary, owners, stewards, tags, status
deleteContainerversionId, containerId
type accepts Model, Directory, Equipment.

Structures

InstructionArguments
listStructuresversionId, parentId, limit, page, includeAttributes
getStructureversionId, structureId
createStructureversionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status
updateStructureversionId, structureId, name, technicalName, description, summary, owners, stewards, tags, status
deleteStructureversionId, structureId
type accepts Table, Document, File, SubStructure, Tag, View.

Fields

InstructionArguments
listFieldsversionId, parentId, limit, page, includeAttributes
getFieldversionId, fieldId
createFieldversionId, structureId, name, type, technicalName, description, summary, columnDataType, size, owners, stewards, tags, status
updateFieldversionId, fieldId, name, technicalName, description, summary, columnDataType, size, owners, stewards, tags, status
deleteFieldversionId, fieldId
type accepts Column, Field. columnDataType is free-form (e.g. varchar, int, date).

Glossary Properties

InstructionArguments
listPropertiesversionId, limit, page, includeAttributes
getPropertyversionId, propertyId
createPropertyversionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status
updatePropertyversionId, propertyId, name, technicalName, description, summary, owners, stewards, tags, status
deletePropertyversionId, propertyId
type accepts Universe, BusinessDomain, BusinessDomainGroup, ReferenceData, ReferenceDataValue, Dimension, DimensionGroup, Concept, Indicator, IndicatorGroup, BusinessTerm.

Usages

InstructionArguments
listUsagesversionId, limit, page, includeAttributes
getUsageversionId, usageId
createUsageversionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status
updateUsageversionId, usageId, name, technicalName, description, summary, owners, stewards, tags, status
deleteUsageversionId, usageId
type accepts Application, Algorithm, Dashboard, Feature, DataSet, OpenDataSet, Screen, Process, Report, Usage, UsageField, UsageComponent.

Data Processing

InstructionArguments
listDataProcessingversionId, limit, page, includeAttributes
getDataProcessingversionId, dataProcessingId
createDataProcessingversionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status
updateDataProcessingversionId, dataProcessingId, name, technicalName, description, summary, owners, stewards, tags, status
deleteDataProcessingversionId, dataProcessingId
type accepts DataFlow, DataProcessing.
InstructionArgumentsDescription
getLinksversionId, fromIdGet all links (relationships) from an entity
createLinkversionId, fromId, toId, typeCreate a link between two entities
deleteLinkversionId, fromId, linkType, toIdDelete a link between two entities

Comments

InstructionArgumentsDescription
listCommentsversionId, entityIdList comments on an entity
createCommentversionId, entityId, contentCreate a comment (supports rich text HTML)

Tasks

InstructionArgumentsDescription
listTasksList tasks assigned to the current user
createTaskversionId, entityId, title, description, type, assignee, statusCreate a task on an entity
updateTaskversionId, entityId, taskId, title, description, status, assigneeUpdate an existing task

DSUL Examples

Search the Catalog

- DataGalaxy.search:
    query: customer
    versionId: '{{versionId}}'
    limit: 20
    output: results

List Workspaces and Versions

- DataGalaxy.listWorkspaces:
    output: workspaces
- DataGalaxy.listVersions:
    workspaceId: '{{workspaces[0].id}}'
    output: versions

Create a Source

- DataGalaxy.createSource:
    versionId: '{{versionId}}'
    name: Customer Database
    type: Database
    technicalName: customer_db
    description: Production customer database
    owners:
      - alice@example.com
    status: Validated
    output: source

Create a Structure and a Field

- DataGalaxy.createStructure:
    versionId: '{{versionId}}'
    parentId: '{{containerId}}'
    name: customers
    type: Table
    output: structure
- DataGalaxy.createField:
    versionId: '{{versionId}}'
    structureId: '{{structure.id}}'
    name: email
    type: Column
    columnDataType: varchar
    size: 255
    output: field
- DataGalaxy.createLink:
    versionId: '{{versionId}}'
    fromId: '{{field.id}}'
    toId: '{{businessTermId}}'
    type: implements
- DataGalaxy.createComment:
    versionId: '{{versionId}}'
    entityId: '{{field.id}}'
    content: <p>Linked to business term.</p>

Error Handling

HTTP StatusErrorSolution
401UnauthorizedVerify the PAT / integration token and baseUrl
403ForbiddenCheck DataGalaxy role and scopes on the workspace version
404Not FoundVerify versionId, objectId and parent IDs
429Rate LimitedBack off and retry with exponential delay

Common Issues

“Not configured” — No credentials could be resolved. Either complete the app install with a valid token, pass an Authorization: Bearer header, or call configureDataGalaxy before the first tool call. “Invalid API key” — The mcp-api-key header does not match the central app secret. Reinstall the app instance to regenerate a signed key. “Credentials lookup failed” — The MCP endpoint could not reach the getConfig webhook of the installed app. Verify that the app instance is still installed in the expected workspace.

External Resources

DataGalaxy API

Official DataGalaxy API documentation

Tool Agents

Plug MCP servers into AI Knowledge agents