Submit a ticket My tickets
Welcome
Login  Sign up

DataGalaxy MCP Server Tools

This page documents the tools exposed by the DataGalaxy MCP server, including their parameters and usage notes. The server exposes 14 tools for browsing workspaces, searching the catalog, reading/updating objects, and managing comments, tasks, tags, technologies, users, and data sources.

1. list_workspaces_and_versions

List every workspace with its versions. Call this first to resolve scope (workspace_id / version_id) for all other tools.

ParameterTypeRequiredDescription
include_archivedbooleanNo (default: false)Include archived versions in each workspace's version list.

2. search_objects

Search catalog objects by free-text name and a few basic filters (name, description, summary, synonyms).

ParameterTypeRequiredDescription
querystringNoFree-text search across name, description, summary, synonyms.
entity_typestringNoObject type filter (e.g. Table, BusinessTerm, DataProduct, Column, Application, etc.).
module_namestringNoModule filter: AiProduct, Processing, DataProduct, Diagram, Catalog, Glossary, Initiative, Objective, Policy, RuleAndMonitor, Usage.
creation_time_operatorenumNoNamed creation-date period filter (e.g. pastWeek, currentMonth).
modification_time_operatorenumNoNamed modification-date period filter.
workspace_idstringNoScope search to a workspace.
version_idstringNoScope to a specific version (requires workspace_id).
limitintegerNo (default: 20, max 50)Results per page.
pageintegerNo (default: 1)Page number.

3. semantic_search

Search catalog objects by semantic similarity (topic/concept based, e.g. "finance-related objects").

ParameterTypeRequiredDescription
querystringYesComplete, standalone query folding in all relevant conversational context.
workspace_idstringNoScope search to a workspace.
version_idstringNoScope to a specific version (requires workspace_id).
limitintegerNo (default: 20, max 50)Results per page.
pageintegerNo (default: 1)Page number.

4. get_object

Overview card for one catalog object: attributes, location, and relation counts/samples (links, children, fields).

ParameterTypeRequiredDescription
object_idstring (UUID)YesUUID of the catalog object.
workspace_idstringYesWorkspace scoping the object.
version_idstringYesVersion scoping the object.
include_writabilitybooleanNo (default: false)Also report which attributes are writable/empty.

5. get_object_attributes

Lists the attributes an object can carry, their formats, and legal values. Call before update_object.

ParameterTypeRequiredDescription
object_idstring (UUID)YesUUID of the catalog object.
workspace_idstringYesWorkspace scoping the object.
version_idstringYesVersion scoping the object.

6. update_object

Change one or more attributes of a catalog object.

ParameterTypeRequiredDescription
object_idstring (UUID)YesUUID of the object to update.
workspace_idstringYesWorkspace scoping the object.
version_idstringYesVersion scoping the object.
attributesobjectYesFlat {name: value} map of attributes to change. Lists (owners, stewards, tags) replace the current value.

7. get_object_relations

Page through one relation of a catalog object: links, children, fields, or ancestors.

ParameterTypeRequiredDescription
object_idstring (UUID)YesUUID of the catalog object.
relationenumYesOne of: links (relationships), children (hierarchy), fields (columns/structure), ancestors (parent chain).
workspace_idstringYesWorkspace scoping the object.
version_idstringYesVersion scoping the object.
limitintegerNo (default: 20, max 50)Items per page.
pageintegerNo (default: 1)Page number.

8. get_comments

List the comments on one catalog object (author, timestamp, message text).

ParameterTypeRequiredDescription
object_idstring (UUID)YesUUID of the catalog object.
workspace_idstringYesWorkspace scoping the object.
version_idstringYesVersion scoping the object.

9. create_comment

Create a new comment on a catalog object. Note: does not support tagging users or teams.

ParameterTypeRequiredDescription
object_idstring (UUID)YesUUID of the catalog object to comment on.
workspace_idstringYesWorkspace scoping the object.
version_idstringYesVersion scoping the object.
messagestringYesComment text (HTML/rich-text markup allowed).

10. get_tasks

List the tasks attached to one catalog object (title, description, status, type, assignee/creator, due date).

ParameterTypeRequiredDescription
object_idstring (UUID)YesUUID of the catalog object.
workspace_idstringYesWorkspace scoping the object.
version_idstringYesVersion scoping the object.

11. get_tags

List every tag defined in the catalog (cross-workspace vocabulary). Takes no arguments.

ParameterTypeRequiredDescription
No parameters.

12. get_technologies

List the technologies defined in the catalog (e.g. PostgreSQL, Snowflake, Azure Data Lake). Takes no arguments.

ParameterTypeRequiredDescription
No parameters.

13. get_users

List catalog users, used to resolve a person into a user ID before setting an owner/steward.

ParameterTypeRequiredDescription
first_namestringNoFilter by first name (exact match).
last_namestringNoFilter by last name (exact match).
limitintegerNo (default: 20, max 50)Results per page.
pageintegerNo (default: 1)Page number.

14. get_data_sources

List the top-level data sources (databases, file stores, NoSQL stores) in a version.

ParameterTypeRequiredDescription
version_idstringYesVersion scoping the listing.
limitintegerNo (default: 20, max 50)Results per page.
pageintegerNo (default: 1)Page number.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.