Skip to content

Data Sources

Data source connections describe where an asset's data comes from — databases, APIs, files, or cloud services. They are distinct from the semantic model and carry connection metadata only (no query logic).


DataSourceConnection

public class DataSourceConnection
{
    public string? ExternalId { get; set; }
    public string Name { get; set; }
    public string Type { get; set; }
    public Dictionary<string, string>? Parameters { get; set; }
}
Property Type Description
ExternalId string? Platform-assigned connection identifier (if available)
Name string Friendly connection name (must be unique within the asset)
Type string Connection type string (e.g. "MySQL", "Postgres", "Web", "Amazon S3", "SharePoint")
Parameters Dictionary<string, string>? Key-value connection parameters (e.g. server, database, URL, path)

Common parameter keys

Parameters are free-form — the keys depend on the connection type and platform. Typical examples:

Type Common keys
SQL Server server, database, schema
MySQL / Postgres server, port, database
Web url
Amazon S3 bucket, region, path
SharePoint siteUrl, list
OData url

SourcesExplorationResult

Used by the site connection layer (connector plugins) when browsing available assets on a remote BI platform. Not stored in the OpenBI session database — it is returned directly from query_site_assets.

public class SourcesExplorationResult
{
    public List<SourcesExplorationWorkspace> Workspaces { get; set; }
}

public class SourcesExplorationWorkspace
{
    public string Name { get; set; }
    public string ExternalID { get; set; }
    public List<SourcesExplorationArtifact> Artifacts { get; set; }
}

public class SourcesExplorationArtifact
{
    public string Name { get; set; }
    public string Path { get; set; }
    public string Type { get; set; }
}

public class SourcesExplorationAsset
{
    public AssetType? Type { get; set; }
    public string ExternalType { get; set; }
    public string ExternalID { get; set; }
}
Class Property Description
SourcesExplorationWorkspace Name Folder / container display name
ExternalID Platform folder ID (used as folder_id in MCP tools)
Artifacts BI artifacts contained in this folder
SourcesExplorationArtifact Name Artifact display name
Path Artifact path or URL
Type Platform-native artifact type
SourcesExplorationAsset Type Normalized AssetType
ExternalType Platform-native type string
ExternalID Platform artifact ID (used as asset_id in download_asset)