Available MCP Tools in Bold Reports®
The hosted Bold Reports® MCP Server provides a comprehensive set of tools that enable AI assistants and MCP-compatible clients to perform reporting operations. These tools allow AI agents to interact with reports, schedules, datasources, users, and permissions while respecting the authenticated user's permissions and access scope.
The MCP Server includes 72 tools organized across 15 resource categories.
Settings Management
Settings management tools configure server-level configurations including security, email, and branding.
| Tool | Description |
|---|---|
| get_ip_whitelist_settings | Retrieves the current IP whitelist settings showing which IP addresses/ranges are allowed to access the Bold Reports® server. |
| update_ip_whitelist_settings | Enables/disables IP whitelisting and replaces the list of allowed IPs/CIDR ranges. |
| generate_embed_secret | Generates a new embed secret key used for embedding Bold Reports® in external applications. |
| update_email_settings | Configures SMTP email settings used for scheduled report delivery and notifications. |
| update_account_settings | Updates server account settings - activation mode, email requirement, and the default group for new users. |
| update_branding | Updates branding elements - logos, favicon, copyright text, and powered-by visibility. (Admins only) |
Attribute Management
Attribute management tools create and manage custom attributes at site, user, and group levels for personalized report filtering.
| Tool | Description |
|---|---|
| add_site_attribute | Adds a new site-level custom attribute available to all reports. |
| get_site_attribute | Lists all site-level custom attributes on the Bold Reports® server. |
| update_site_attribute | Updates an existing site-level attribute. |
| delete_site_attribute | Deletes a site-level attribute by its ID. |
| add_user_attribute | Adds a custom attribute to a specific user for personalized report filtering. |
| get_user_attribute | Gets a user attribute by its attribute ID. |
| update_user_attribute | Updates an existing user attribute. |
| delete_user_attribute | Deletes a user attribute by its ID. |
| add_group_attribute | Adds a custom attribute to a group for group-level filtering. |
| get_group_attribute | Retrieves the custom attribute(s) for a group. |
| update_group_attribute | Updates an existing group attribute. |
| delete_group_attribute | Deletes a group attribute by its ID. |
User Management
User management tools allow creation, modification, and management of user accounts on the Bold Reports® server.
| Tool | Description |
|---|---|
| get_users | Returns a paginated list of all users on the Bold Reports® server. |
| get_user_detail | Gets detailed profile information for a user by email or username. |
| add_user | Creates a new user, optionally assigning them to the default group. |
| edit_user | Updates an existing user's profile. |
| activate_or_deactivate_user | Activates or deactivates a user account to control login access. |
| delete_user | Permanently deletes a user. |
| get_user_groups | Returns the groups a specific user belongs to. |
| download_csv_template | Downloads the CSV template used for bulk user import. |
Group Management
Group management tools enable creation and administration of user groups for simplified permission and access control.
| Tool | Description |
|---|---|
| get_groups | Returns a paginated list of all groups. |
| get_group_detail | Gets detailed information for a specific group. |
| add_group | Creates a new group on the server. |
| edit_group | Updates an existing group's name and description. |
| delete_group | Permanently deletes a group. |
| get_group_users | Returns the users that belong to a specific group. |
| add_users_to_group | Adds one or more users to a group by group name. |
| delete_group_users | Removes one or more users from a group by IDs. |
Permission Management
Permission management tools control user and group access to reports and resources across the server.
| Tool | Description |
|---|---|
| get_user_permissions | Returns all permissions assigned to a user across items. |
| get_group_permissions | Returns all permissions assigned to a group. |
| add_user_permissions | Adds multiple user permissions in a single call. (Admins only) |
| add_group_permissions | Adds multiple group permissions in a single call. (Admins only) |
| delete_user_permission | Deletes a specific user permission by its ID. |
| delete_group_permission | Deletes a specific group permission by its ID. |
Category Management
Category management tools organize reports into logical folders and hierarchical structures.
| Tool | Description |
|---|---|
| list_categories | Lists all top-level report categories. |
| add_category | Creates a new category or subcategory. |
| update_category | Updates an existing category name or description. |
Item Management
Item management tools provide discovery, organization, and lifecycle management for all items (reports, datasources, datasets, categories).
| Tool | Description |
|---|---|
| get_item_detail | Gets detailed metadata for any item (report, datasource, dataset, category) by ID. |
| get_items | Returns a paginated list of items, optionally filtered by category path and tags. |
| delete_item | Deletes an item by its ID. |
| delete_item_by_path | Deletes an item by its type and server path. |
| move_item | Moves a report to a different category. |
| get_item_location | Returns the file-system location of an item. |
| check_item_name_exists | Checks whether an item name already exists to avoid naming conflicts. |
| get_version_history | Returns the complete version history of an item. |
| get_latest_version_history | Returns the latest version details for one or more items. |
| get_tags | Returns all tags configured on the server. |
Report Management
Report management tools support the complete lifecycle of reporting operations including updates, parameter retrieval, and cascading filters.
| Tool | Description |
|---|---|
| update_report | Updates a report's name/description or full metadata, datasource/dataset mappings, tags, and content. |
| get_report_parameters | Returns the list of parameters defined for a report. |
| get_cascading_parameters | Returns cascading (dependent) parameter values based on currently selected parameter values. |
Datasource Management
Datasource management tools create and configure data connections supporting multiple database and API types.
| Tool | Description |
|---|---|
| add_datasource | Adds a new datasource. Supports SQL, SQLCE, OLEDB, ODBC, Oracle, XML, SSAS, PostgreSQL, MySQL, WebApi. |
| update_datasource | Updates an existing datasource with new connection settings or credentials. |
Dataset Management
Dataset management tools manage data transformation and query definitions for reports.
| Tool | Description |
|---|---|
| add_dataset | Adds a new dataset. Requires create access for datasets. |
| update_dataset | Updates an existing dataset name, definition, or data source mappings. |
Export Operations
Export operations tools enable exporting reports to multiple file formats.
| Tool | Description |
|---|---|
| export_report | Exports a report to a file (Excel, Html, Pdf, Word, PPT, CSV). |
| download_item | Downloads a report or dataset by item ID. |
File Management
File management tools provide access to downloadable files on the server.
| Tool | Description |
|---|---|
| get_files | Lists all files available for download on the server. |
Report Copying
Report copying tools duplicate reports with optional datasource and dataset remapping.
| Tool | Description |
|---|---|
| copy_report | Copies a report to a different category, with optional datasource/dataset/subreport remapping. |
Publishing Operations
Publishing operations tools enable sharing reports to external Bold Reports® sites.
| Tool | Description |
|---|---|
| add_external_site | Registers an external Bold Reports® site so reports can be published to it. |
| publish_report | Publishes a report to an internal or external site. |
Schedule Management
Schedule management tools automate recurring report delivery via email, FTP, S3, or local storage.
| Tool | Description |
|---|---|
| add_schedule | Creates a recurring schedule that exports a report and delivers it via email/FTP/S3/Local. |
| update_schedule | Updates an existing schedule's recurrence, delivery method, or subscribers. |
| delete_schedule | Deletes a schedule by its ID. |
| get_schedule_detail | Returns detailed information about a specific schedule. |
| get_all_schedule_items | Lists all schedule items across all reports on the server. |
| run_schedule_now | Triggers a schedule to run immediately, outside its normal recurrence. |
Recommended First Test
Before performing actions such as creating or updating reports, verify your MCP connection using a read-only request.
Example Prompts
- List all available reports.
- Show me report categories.
- What datasources are configured?
- Get report details for Sales Report.
- List all users and groups.
These confirm that authentication, permissions, and connectivity are working correctly before running action-oriented tools.