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)
- Usage as App
- Usage as MCP
Installation
- Go to Apps in your workspace
- Search for DataGalaxy and install it
- Open the app instance configuration and fill in the required fields
Configuration
| Field | Description |
|---|---|
| DataGalaxy API Base URL | Base URL of the DataGalaxy API (default https://api.datagalaxy.com) |
| Authentication Token | PAT or integration token, stored as a workspace secret |
| MCP Endpoint | Auto-populated on install — URL of the MCP endpoint for this instance |
| MCP API Key | Auto-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 viabuildAppAuth. Unless stated otherwise, all IDs use DataGalaxy’s DoubleUuid format and versionId refers to a workspace version ID returned by listVersions.Search & Workspaces
| Instruction | Arguments | Description |
|---|---|---|
search | query, versionId, limit, filters | Search across all DataGalaxy objects by name, technical name, description or summary |
listWorkspaces | – | List all DataGalaxy workspaces accessible to the authenticated user |
listVersions | workspaceId | List all versions of a DataGalaxy workspace |
listAttributes | – | List all attributes (custom and built-in) defined in your DataGalaxy client space |
Generic Object Operations
| Instruction | Arguments | Description |
|---|---|---|
getObject | versionId, objectId | Get details of any DataGalaxy object by its ID and version |
updateObject | versionId, objectId, name, status, description, summary, owners, stewards, tags, technicalName | Update attributes of any DataGalaxy object |
status accepts Proposed, InRevision, Validated, InValidation, Obsolete.Sources
| Instruction | Arguments |
|---|---|
listSources | versionId, limit, page, includeAttributes |
getSource | versionId, sourceId |
createSource | versionId, name, type, technicalName, description, summary, owners, stewards, tags, status |
updateSource | versionId, sourceId, name, technicalName, description, summary, owners, stewards, tags, status |
deleteSource | versionId, sourceId |
Containers
| Instruction | Arguments |
|---|---|
listContainers | versionId, parentId, limit, page, includeAttributes |
getContainer | versionId, containerId |
createContainer | versionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status |
updateContainer | versionId, containerId, name, technicalName, description, summary, owners, stewards, tags, status |
deleteContainer | versionId, containerId |
type accepts Model, Directory, Equipment.Structures
| Instruction | Arguments |
|---|---|
listStructures | versionId, parentId, limit, page, includeAttributes |
getStructure | versionId, structureId |
createStructure | versionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status |
updateStructure | versionId, structureId, name, technicalName, description, summary, owners, stewards, tags, status |
deleteStructure | versionId, structureId |
type accepts Table, Document, File, SubStructure, Tag, View.Fields
| Instruction | Arguments |
|---|---|
listFields | versionId, parentId, limit, page, includeAttributes |
getField | versionId, fieldId |
createField | versionId, structureId, name, type, technicalName, description, summary, columnDataType, size, owners, stewards, tags, status |
updateField | versionId, fieldId, name, technicalName, description, summary, columnDataType, size, owners, stewards, tags, status |
deleteField | versionId, fieldId |
type accepts Column, Field. columnDataType is free-form (e.g. varchar, int, date).Glossary Properties
| Instruction | Arguments |
|---|---|
listProperties | versionId, limit, page, includeAttributes |
getProperty | versionId, propertyId |
createProperty | versionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status |
updateProperty | versionId, propertyId, name, technicalName, description, summary, owners, stewards, tags, status |
deleteProperty | versionId, propertyId |
type accepts Universe, BusinessDomain, BusinessDomainGroup, ReferenceData, ReferenceDataValue, Dimension, DimensionGroup, Concept, Indicator, IndicatorGroup, BusinessTerm.Usages
| Instruction | Arguments |
|---|---|
listUsages | versionId, limit, page, includeAttributes |
getUsage | versionId, usageId |
createUsage | versionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status |
updateUsage | versionId, usageId, name, technicalName, description, summary, owners, stewards, tags, status |
deleteUsage | versionId, usageId |
type accepts Application, Algorithm, Dashboard, Feature, DataSet, OpenDataSet, Screen, Process, Report, Usage, UsageField, UsageComponent.Data Processing
| Instruction | Arguments |
|---|---|
listDataProcessing | versionId, limit, page, includeAttributes |
getDataProcessing | versionId, dataProcessingId |
createDataProcessing | versionId, parentId, name, type, technicalName, description, summary, owners, stewards, tags, status |
updateDataProcessing | versionId, dataProcessingId, name, technicalName, description, summary, owners, stewards, tags, status |
deleteDataProcessing | versionId, dataProcessingId |
type accepts DataFlow, DataProcessing.Links
| Instruction | Arguments | Description |
|---|---|---|
getLinks | versionId, fromId | Get all links (relationships) from an entity |
createLink | versionId, fromId, toId, type | Create a link between two entities |
deleteLink | versionId, fromId, linkType, toId | Delete a link between two entities |
Comments
| Instruction | Arguments | Description |
|---|---|---|
listComments | versionId, entityId | List comments on an entity |
createComment | versionId, entityId, content | Create a comment (supports rich text HTML) |
Tasks
| Instruction | Arguments | Description |
|---|---|---|
listTasks | – | List tasks assigned to the current user |
createTask | versionId, entityId, title, description, type, assignee, status | Create a task on an entity |
updateTask | versionId, entityId, taskId, title, description, status, assignee | Update an existing task |
DSUL Examples
Search the Catalog
List Workspaces and Versions
Create a Source
Create a Structure and a Field
Link Two Entities and Comment
Error Handling
| HTTP Status | Error | Solution |
|---|---|---|
| 401 | Unauthorized | Verify the PAT / integration token and baseUrl |
| 403 | Forbidden | Check DataGalaxy role and scopes on the workspace version |
| 404 | Not Found | Verify versionId, objectId and parent IDs |
| 429 | Rate Limited | Back 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 anAuthorization: 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