Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Infor Birst MCP Serverlist all reports in the sales analytics space"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Infor Birst MCP Server
An MCP (Model Context Protocol) server that exposes Infor Birst's analytics platform capabilities as AI-consumable tools.
Features
41 MCP Tools enabled by default, organized in 7 tiers (up to 46 with optional features):
Tier 1: Core Query Tools (0-5 tools, optional)
These tools execute queries against live data and are disabled by default as a safeguard. Enable them explicitly when needed.
GenAI Tools (require Birst AI entitlement - set BIRST_ENABLE_GENAI=true):
birst_generate_bql- Convert natural language to BQL queriesbirst_search_data- Search data warehouse with natural languagebirst_generate_chart- Generate chart specifications from text
ICW Tools (require application provisioning - set BIRST_ENABLE_ICW=true):
birst_execute_query- Execute BQL queries and return resultsbirst_validate_query- Validate BQL syntax before execution
Why disabled by default? These tools can execute arbitrary queries against your data warehouse. Requiring explicit opt-in ensures you consciously enable query execution capabilities.
Tier 2: Discovery Tools (8 tools)
birst_list_spaces- List all accessible analytical spacesbirst_get_space- Get detailed space informationbirst_list_reports- List reports in a space (with pagination)birst_get_report- Get detailed report informationbirst_list_dashboards- List dashboards in collectionsbirst_get_dashboard- Get detailed dashboard informationbirst_list_collections- List collections in a spacebirst_search_catalog- Search catalog entities
Tier 3: Infrastructure Tools (17 tools)
birst_list_connections- List data connectionsbirst_list_sources- List data sourcesbirst_get_source- Get source detailsbirst_create_source- Create a new sourcebirst_update_source- Update source configurationbirst_delete_source- Delete a sourcebirst_list_joins- List joins between sourcesbirst_create_join- Create a join relationshipbirst_delete_join- Delete a join relationshipbirst_list_variables- List space variables (includes GUID for CRUD)birst_create_variable- Create a new variablebirst_update_variable- Update a variablebirst_delete_variable- Delete a variablebirst_list_hierarchies- List dimensional hierarchiesbirst_create_hierarchy- Create a hierarchybirst_add_hierarchy_level- Add level to hierarchybirst_get_dataflow- Get data flow visualization
Tier 4: Workflow Tools (4 tools)
birst_list_workflows- List available workflowsbirst_run_workflow- Trigger workflow executionbirst_get_workflow_status- Monitor workflow statusbirst_list_workflow_runs- Get workflow execution history
Tier 5: Administration Tools (5 tools)
birst_list_users- List users in accountbirst_list_space_users- List users with space accessbirst_list_account_groups- List account groupsbirst_list_space_groups- List space groupsbirst_space_action- Perform space actions (replicate, publish, clear cache, etc.)
Tier 6: Job Tracking Tools (2 tools)
birst_get_job_status- Get status of a running/completed jobbirst_job_action- Cancel or clear job status
Tier 7: Package Management Tools (5 tools)
birst_list_packages- List packages in a spacebirst_list_available_packages- List packages available for importbirst_import_package- Import a package into a spacebirst_create_package- Create a new packagebirst_delete_package- Delete a package
Installation
npm installConfiguration
Environment Variables
Variable | Description | Default |
| Environment to use (TST, PRD, TRN) | TST |
| Custom path to .ionapi file | Auto-detected |
| Log level (debug, info, warn, error) | info |
| Enable GenAI tools (requires Birst AI entitlement) | false |
| Enable ICW query tools (requires app provisioning) | false |
ION API Credentials
Place your .ionapi files in the project root or credentials/ directory:
infor-birst-mcp/
├── TST.ionapi # Test environment
├── PRD.ionapi # Production environment
└── TRN.ionapi # Training environmentThe .ionapi file is obtained from Infor Cloud Suite and contains OAuth2 credentials.
Usage
Development
npm run devProduction
npm run build
npm startClaude Code Configuration
Add to your Claude Code MCP settings:
{
"mcpServers": {
"infor-birst": {
"command": "node",
"args": ["/path/to/infor-birst-mcp/dist/index.js"],
"env": {
"BIRST_ENV": "TST"
}
}
}
}To enable query execution tools:
{
"mcpServers": {
"infor-birst": {
"command": "node",
"args": ["/path/to/infor-birst-mcp/dist/index.js"],
"env": {
"BIRST_ENV": "TST",
"BIRST_ENABLE_ICW": "true",
"BIRST_ENABLE_GENAI": "true"
}
}
}
}Testing with MCP Inspector
Use the MCP Inspector to test tools interactively:
# Basic (41 tools)
BIRST_ENV=TST npx @modelcontextprotocol/inspector node dist/index.js
# With query tools enabled (46 tools)
BIRST_ENV=TST BIRST_ENABLE_ICW=true BIRST_ENABLE_GENAI=true npx @modelcontextprotocol/inspector node dist/index.jsThis opens a web UI where you can call any tool and see responses.
Example Usage
Once configured, you can use the tools in Claude:
"List all my Birst spaces"
→ Uses birst_list_spaces
"Show me reports in this space"
→ Uses birst_list_reports
"What workflows are scheduled to run?"
→ Uses birst_list_workflows with filter=isScheduled
"Who has access to this space?"
→ Uses birst_list_space_usersWith GenAI enabled (BIRST_ENABLE_GENAI=true):
"Show me sales by region for 2024"
→ Uses birst_generate_bql + birst_execute_querySupported Environments
TST - Test environment
PRD - Production environment
TRN - Training environment
Switch environments by setting the BIRST_ENV variable or using the default (TST).
API Coverage
This MCP server interfaces with 3 Birst APIs:
API | Endpoints | Description |
REST API | 156 | Space management, users, workflows |
GenAI API | 3 | Natural language to BQL, chart generation |
ICW API | 5 | Query execution and validation |
Security
Credentials are stored in
.ionapifiles (gitignored)OAuth2 tokens are automatically refreshed
All API calls are authenticated via Bearer token
Sensitive data is never logged
License
MIT
This server cannot be installed
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.