项目简介
这是一个遵循 Model Context Protocol (MCP) 标准实现的服务器,专注于提供通过编程方式生成 AntV 图表的能力。它接收来自 LLM 客户端的请求,根据提供的工具名称和参数,调用内部逻辑生成图表,并将图表链接返回给客户端。
主要功能点
- 生成折线图 (generate_line_chart): 根据时间序列数据生成折线图,适合展示趋势。
- 生成柱状图 (generate_column_chart): 根据分类数据生成柱状图,适合比较不同类别的值。支持分组和堆叠。
- 生成饼状图 (generate_pie_chart): 根据分类数据生成饼状图或圆环图,适合展示部分占总体的比例。
- 生成面积图 (generate_area_chart): 根据时间序列数据生成面积图,适合展示趋势并强调总量或累积值。支持堆叠。
所有图表生成工具都允许设置图表标题、X轴标题和Y轴标题。
安装步骤
作为 MCP 服务器,它通常会被 MCP 客户端(如支持 MCP 协议的 LLM 应用程序)自动启动。您无需手动安装或启动它。客户端会使用 'npx' 命令来运行此服务器。
如果您需要进行开发或测试,可以按以下步骤操作:
- 克隆仓库或下载代码。
- 确保您已安装 Node.js 和 npm。
- 在项目根目录下运行 'npm install' 安装依赖。
- 运行 'npm run build' 构建项目。
- 运行 'npm run start' 启动服务器(通常用于测试,生产环境中由客户端启动)。
MCP 服务器配置
要让支持 MCP 协议的 LLM 客户端使用此服务器,需要在客户端的配置中添加该服务器的信息。典型的配置需要指定服务器的名称、启动命令及其参数。
配置时,需要提供以下信息:
- 服务器名称 (server name): 用于在客户端区分不同的 MCP 服务器,例如可以命名为 'chart-server' 或 'antv-charts'。仓库中推荐的示例名称是 'quickchart-server'。
- 启动命令 (command): 客户端用于启动服务器的可执行文件路径。对于这个服务器,推荐使用 'npx',它会自动下载并运行 npm 包。
- 启动参数 (args): 传递给启动命令的参数。使用 'npx' 时,参数应为 '-y'(自动确认安装)和服务器的 npm 包名 '@antv/mcp-server-chart'。
客户端配置示例(仅说明配置项及含义,请勿复制以下代码块到客户端配置中):
// MCP客户端配置文件的片段示例 { "mcpServers": { "your-server-name": { // 此处替换为您为该服务器指定的名称 "command": "npx", // 启动服务器的命令 "args": [ // 传递给启动命令的参数 "-y", // npx 参数,用于自动确认安装 "@antv/mcp-server-chart" // 服务器的 npm 包名 ] } // 客户端可能配置的其他 MCP 服务器 } }
请根据您的 MCP 客户端的具体配置格式,添加上述信息。
基本使用方法
配置完成后,支持 MCP 的 LLM 客户端将能够识别并调用此服务器提供的图表生成工具。
当您在与 LLM 交互时,如果模型判断需要生成图表来回答您的问题或展示数据,它可能会自动调用服务器提供的工具(例如 'generate_line_chart'),并向服务器发送包含图表数据和配置参数的请求。
服务器接收请求后,会调用 AntV 的在线服务生成图表,并将生成的图表 URL 返回给 LLM 客户端。最终,LLM 客户端会将这个图表 URL 展示给您。您只需向 LLM 描述您希望用图表展示的数据和类型即可。
信息
分类
AI与计算