Birst MCP 服务器

一个将Infor Birst分析平台功能暴露为AI可消费工具的MCP(模型上下文协议)服务器。

  • by MikahDev
  • TypeScript
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 MikahDev/infor-birst-mcp

使用说明

Infor Birst MCP服务器

MCP(模型上下文协议)服务器,将Infor Birst的分析平台功能作为人工智能消费工具公开。

特性

41 MCP工具 默认情况下启用,按7层组织(最多46层,具有可选功能):

第1层:核心查询工具(0-5个工具,可选)

这些工具对实时数据执行查询 默认情况下禁用 作为一种保障。必要时明确启用它们。

GenAI工具 (需要Birst AI权限-设置 BIRST_ENABLE_GENAI=true):

  • birst_generate_bql -将自然语言转换为BQL查询
  • birst_search_data -用自然语言搜索数据仓库
  • birst_generate_chart -从文本生成图表规范

ICW工具 (需要应用程序配置-设置 BIRST_ENABLE_ICW=true):

  • birst_execute_query -执行BQL查询并返回结果
  • birst_validate_query -执行前验证BQL语法

为什么默认禁用? 这些工具可以对您的数据仓库执行任意查询。要求明确的选择加入可确保您有意识地启用查询执行功能。

第2层:发现工具(8个工具)

  • birst_list_spaces -列出所有可访问的分析空间
  • birst_get_space -获取详细的空间信息
  • birst_list_reports -在空间中列出报告(带分页)
  • birst_get_report -获取详细的报告信息
  • birst_list_dashboards -在集合中列出仪表板
  • birst_get_dashboard -获取详细的仪表板信息
  • birst_list_collections -列出空间中的集合
  • birst_search_catalog -搜索目录实体

第3层:基础设施工具(17个工具)

  • birst_list_connections -列出数据连接
  • birst_list_sources -列出数据源
  • birst_get_source -获取源详细信息
  • birst_create_source -创建新源
  • birst_update_source -更新源配置
  • birst_delete_source -删除源
  • birst_list_joins -列出源之间的联接
  • birst_create_join -创建加入关系
  • birst_delete_join -删除加入关系
  • birst_list_variables -列出空间变量(包括CRUD的GUID)
  • birst_create_variable -创建新变量
  • birst_update_variable -更新变量
  • birst_delete_variable -删除变量
  • birst_list_hierarchies -列出维度层次结构
  • birst_create_hierarchy -创建层次结构
  • birst_add_hierarchy_level -向层次结构添加级别
  • birst_get_dataflow -获取数据流可视化

第4层:工作流工具(4个工具)

  • birst_list_workflows -列出可用工作流
  • birst_run_workflow -触发工作流执行
  • birst_get_workflow_status -监控工作流状态
  • birst_list_workflow_runs -获取工作流执行历史记录

第5层:管理工具(5个工具)

  • birst_list_users -列出帐户中的用户
  • birst_list_space_users -列出具有空间访问权限的用户
  • birst_list_account_groups -列出帐户组
  • birst_list_space_groups -列出空间组
  • birst_space_action -执行空间操作(复制、发布、清除缓存等)

第6层:工作跟踪工具(2个工具)

  • birst_get_job_status -获取正在运行/已完成作业的状态
  • birst_job_action -取消或清除作业状态

第7层:包管理工具(5个工具)

  • birst_list_packages -列出空间中的包
  • birst_list_available_packages -列出可导入的包
  • birst_import_package -将包导入空间
  • birst_create_package -创建新包
  • birst_delete_package -删除包

安装

npm install

配置

环境变量

变量 描述 默认值
BIRST_ENV 使用环境(TST、PRD、TRN) TST
BIRST_IONAPI_PATH .ionapi文件的自定义路径 自动检测到
BIRST_LOG_LEVEL 日志级别(调试、信息、警告、错误) info
BIRST_ENABLE_GENAI 启用GenAI工具(需要Birst AI授权) false
BIRST_ENABLE_ICW 启用ICW查询工具(需要应用程序配置) false

ION API证书

放置您的 .ionapi 项目根目录中的文件或 credentials/ 目录:

infor-birst-mcp/
├── TST.ionapi    # Test environment
├── PRD.ionapi    # Production environment
└── TRN.ionapi    # Training environment

这 .ionapi 该文件从Infor Cloud Suite获得,包含OAuth2凭据。

用法

发展

npm run dev

生产

npm run build
npm start

Claude代码配置

添加到您的Claude Code MCP设置中:

{
  "mcpServers": {
    "infor-birst": {
      "command": "node",
      "args": ["/path/to/infor-birst-mcp/dist/index.js"],
      "env": {
        "BIRST_ENV": "TST"
      }
    }
  }
}

要启用查询执行工具,请执行以下操作:

{
  "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"
      }
    }
  }
}

MCP检验员测试

使用MCP检查器交互式测试工具:

# 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.js

这将打开一个web UI,您可以在其中调用任何工具并查看响应。

示例用法

配置后,您可以使用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_users

启用GenAI(BIRST_ENABLE_GENAI=true):

"Show me sales by region for 2024"
→ Uses birst_generate_bql + birst_execute_query

支持的环境

  • 测试 -测试环境
  • 产品需求文档 -生产环境
  • 转录 -培训环境

通过设置来切换环境 BIRST_ENV 变量或使用默认值(TST)。

API覆盖范围

此MCP服务器与3个Birst API接口:

API 端点 描述
REST API 156 空间管理、用户、工作流
GenAI API 3 自然语言到BQL,图表生成
ICW API 5 查询执行和验证

安全

  • 凭据存储在 .ionapi 文件(gitignored)
  • OAuth2令牌会自动刷新
  • 所有API调用都通过Bearer令牌进行身份验证
  • 从不记录敏感数据

许可证

麻省理工学院