Infor Birst

You operate the Infor Birst MCP Server to expose Birst analytics capabilities as AI-consumable tools. This server lets you discover spaces, reports, data sources, workflows, and more, and it can enable GenAI-powered queries when you have the appropriate entitlements.

How to use

You interact with the MCP server through a client that can invoke named tools. Tools are organized by function, from discovery and infrastructure to workflows and administration. If you enable GenAI, you gain access to natural language to BQL conversions and chart generation. Start by configuring the MCP server in your environment, then connect your MCP client to the local or remote server and begin issuing tool requests by name.

Typical usage patterns include listing spaces, getting space details, listing reports or dashboards, and triggering workflows. If you want natural language capabilities, enable GenAI tools by setting the appropriate environment variable and ensure you have the required entitlement. You can also monitor workflow status and view execution history to manage automated processes.

How to install

Prerequisites: Node.js and npm installed on your machine.

Step 1: Install the project dependencies.

npm install

Step 2: Run in development mode to test locally.

npm run dev

Step 3: Build for production and start the server.

npm run build
npm start

Configuration and runtime essentials

Configure environment variables to tailor the MCP server behavior. You can switch environments (Test, Production, Training) by setting the BIRST_ENV variable.

Environment variables you may use include BIRST_ENV, BIRST_IONAPI_PATH, BIRST_LOG_LEVEL, BIRST_ENABLE_GENAI, and BIRST_ENABLE_ICW.

Place your .ionapi credentials in the project root or credentials/ directory to provide OAuth2 access for Infor Cloud APIs.

Examples and workflows

Once configured, you can use the MCP tools directly. For example, list all accessible spaces, show reports in a specific space, and query for workflow status or execution history.

If GenAI is enabled, you can translate natural language requests into BQL and run queries to retrieve results.

Available tools

birst_list_spaces

List all accessible analytical spaces in the Birst account.

birst_get_space

Retrieve detailed information about a specific space.

birst_list_reports

List reports within a space, with support for pagination.

birst_list_dashboards

List dashboards within collections.

birst_list_collections

List collections in a space.

birst_search_catalog

Search catalog entities to locate data assets.

birst_list_connections

List available data connections.

birst_list_sources

List data sources.

birst_list_variables

List variables within a space.

birst_list_hierarchies

List dimensional hierarchies.

birst_get_dataflow

Retrieve data flow visualization information.

birst_list_workflows

List available workflows.

birst_run_workflow

Trigger a workflow execution.

birst_get_workflow_status

Monitor the status of a running workflow.

birst_list_workflow_runs

Get the execution history of workflows.

birst_list_users

List users in the account.

birst_list_space_users

List users with access to a specific space.

birst_list_account_groups

List account groups.

birst_list_space_groups

List space groups.

birst_generate_bql

Convert natural language prompts to BQL queries (GenAI, requires entitlement).

birst_search_data

Search data warehouse with natural language (GenAI, requires entitlement).

birst_generate_chart

Generate chart specifications from text (GenAI, requires entitlement).

birst_execute_query

Execute BQL queries and return results (ICW).

birst_validate_query

Validate BQL syntax before execution (ICW).