使用说明
项目简介
BI Chart MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器,旨在为大型语言模型(LLM)驱动的BI应用提供数据可视化能力。它允许LLM客户端通过标准化的MCP协议,调用服务器提供的工具来加载数据、创建图表、并管理业务洞察。
主要功能点
- 数据加载工具: 支持从多种数据源(如CSV文件)加载数据,为后续可视化分析提供数据基础。
- 图表生成工具: 能够根据用户指令,基于加载的数据生成各种类型的BI图表,如柱状图、折线图等。
- 业务洞察管理: 提供记录和管理图表业务洞察的功能,允许用户为特定图表添加业务分析和结论。
- MCP协议标准: 完全遵循MCP协议规范,保证与任何兼容MCP协议的LLM客户端无缝对接。
- 资源管理: 服务器端管理图表等资源,并提供标准的资源访问接口。
- Prompt模板: 预置了创建仪表板和分析趋势等Prompt模板,简化LLM应用与服务器的交互。
安装步骤
-
克隆仓库
git clone https://github.com/c-cf/BI-Chart-MCP-Server.git cd BI-Chart-MCP-Server -
创建并激活虚拟环境 (推荐)
python -m venv .venv source .venv/bin/activate # Linux/macOS .venv\Scripts\activate # Windows -
安装依赖
pip install -r requirements.txt
服务器配置
MCP客户端需要配置以下JSON格式信息以连接到 BI Chart MCP Server。
{ "serverName": "mcp-bi-visualizer", // 服务器名称,与server.py中 BiVisualizerServer 初始化时name参数一致 "command": "python", // 启动服务器的命令,这里使用python "args": [ // 启动命令的参数列表 "-m", // 以模块运行Python "mcp_bi_visualizer.server" // 运行 mcp_bi_visualizer 模块下的 server.py ] }
参数注释:
- 'serverName': MCP服务器的名称,客户端用此名称标识和连接服务器。
- 'command': 启动服务器进程的命令,通常是Python解释器。
- 'args': 传递给启动命令的参数列表,用于指定要运行的服务器脚本或模块。
基本使用方法
-
启动服务器 打开终端,进入项目根目录,运行以下命令启动BI Chart MCP Server:
python scripts/run_server.py或者
python -m mcp_bi_visualizer.server服务器启动后,将监听标准输入输出 (stdio) 以接收和发送MCP协议的消息。
-
配置MCP客户端 在兼容MCP协议的LLM客户端中,根据 服务器配置 章节的JSON配置信息,添加并配置 BI Chart MCP Server。
-
使用LLM客户端与服务器交互 通过LLM客户端,可以调用BI Chart MCP Server提供的工具和Prompt模板,例如:
- 使用 'load_data' 工具加载CSV数据文件。
- 使用 'create_visualization' 工具基于加载的数据创建图表。
- 使用 'add_insight' 工具为图表添加业务洞察。
- 使用 'create-dashboard' 或 'analyze-trends' Prompt模板,引导LLM进行更高级的BI分析任务。
注意: BI Chart MCP Server 通过标准输入输出 (stdio) 与客户端通信,确保LLM客户端支持 stdio 传输协议。
信息
分类
商业系统