Skip to content

Tools Overview

The OpenBI MCP Server exposes 53 tools organized around a session-based workflow.


Session pattern

All tools (except create_session and list_sites) require a session_id. The typical flow is:

create_session → (work with tools) → [session persists until server restart]
  1. create_session allocates a private working session and binds it to a site.
  2. You populate the session by either:
    • Creating assets from scratch (create_asset, then adding pages, visuals, tables…).
    • Importing an existing asset from disk (load_openbi_asset).
    • Downloading from a live BI platform (download_asset).
  3. You modify the session data using the CRUD tools.
  4. You publish back to the BI platform with upload_asset.

Sessions do not persist across server restarts.


All tools

# Tool Group R/O Description
1 create_session Session Create a new session bound to a site
2 list_sites Discovery List all registered sites
3 list_bi_platforms Discovery List available BI platforms
4 list_bi_platform_visual_types Discovery Visual type catalog for a platform
5 list_bi_platform_asset_types Discovery Asset types available for a platform
6 get_bi_platform_asset_type_instructions Discovery Authoring instructions for one asset type
7 query_site_assets Discovery Browse remote assets on a BI site
8 get_folders Discovery List folders on a site
9 create_folder Discovery Create a new folder on a site
10 create_asset Assets Create an empty asset in the session
11 list_assets Assets List assets in the session
12 update_asset Assets Update asset name / description
13 list_asset_dependencies Assets List inter-asset dependencies
14 load_openbi_asset Assets Import an OpenBI JSON file into the session
15 add_metadata Assets Add/update AssetInfo additional metadata
16 download_asset Download/Upload Download + convert a remote asset into the session
17 upload_asset Download/Upload Convert + upload a session asset to the BI site
18 get_pages Pages List all pages in the session asset
19 get_page Pages Get a single page with visuals and filters
20 create_page Pages Create a new page
21 update_page Pages Update page properties
22 delete_page Pages Delete a page and all its visuals
23 get_visuals Visuals List top-level visuals on a page
24 get_visual Visuals Get a visual with projections and filters
25 create_visual Visuals Create a new visual on a page
26 update_visual Visuals Update visual properties
27 delete_visual Visuals Delete a visual and its children
28 get_visual_projections Visuals List projections for a visual
29 get_visual_projection Visuals Get a single projection
30 create_visual_projection Visuals Create a data field binding on a visual
31 update_visual_projection Visuals Update a projection
32 delete_visual_projection Visuals Delete a projection
33 get_tables Data Model List all tables in the session asset
34 get_table Data Model Get a table with its columns
35 create_table Data Model Create a new table
36 update_table Data Model Update table properties
37 delete_table Data Model Delete a table and all its columns
38 get_columns Data Model List columns in a table
39 get_column Data Model Get a single column
40 create_column Data Model Create a column or measure
41 update_column Data Model Update a column
42 delete_column Data Model Delete a column
43 get_relationships Data Model List all relationships
44 get_relationship Data Model Get a single relationship
45 create_relationship Data Model Create a relationship between columns
46 delete_relationship Data Model Delete a relationship
47 get_filters Filters List filters for a page or visual
48 get_filter Filters Get a single filter
49 create_filter Filters Create a filter on a page or visual
50 delete_filter Filters Delete a filter
51 get_data_source_connections Filters List data source connections for an asset
52 get_data_source_connection Filters Get a single data source connection
53 create_data_source_connection Filters Create a data source connection

R/O = read-only (does not modify session state).


Typical authoring workflow (new asset)

1. list_sites                           → pick id_site
2. list_bi_platforms                    → pick platform_id
3. list_bi_platform_asset_types         → pick asset_type_id
4. get_bi_platform_asset_type_instructions  → read authoring rules
5. create_session (id_site)             → get session_id
6. create_asset (session_id, ...)       → get asset_id
7. [create tables / columns / relationships]
8. [create pages / visuals / projections / filters]
9. upload_asset (session_id, asset_id, folder_id)

Typical download-and-inspect workflow

1. create_session (id_site)
2. query_site_assets (session_id, id_site)  → find asset_id + asset_type
3. download_asset (session_id, id_site, asset_id, asset_type)
4. list_assets / get_tables / get_pages / ...