使用说明

项目简介

Quick Chart MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器，它将 Quick Chart 图表服务封装成一系列标准化的工具，供 LLM (大型语言模型) 客户端调用。通过该 MCP 服务器，LLM 可以方便地生成各种图表并获取图表图片的链接。

主要功能点

图表生成工具: 提供了与 Quick Chart API 交互的工具，允许 LLM 通过 JSON 格式的参数定义图表。
获取图表链接: 通过 'GetChartImgLink' 工具，LLM 可以根据图表参数获取 Quick Chart 生成的图表图片链接。
本地安装 Quick Chart 指南: 提供 'InstallQuickChart' 工具，返回在本地 Docker 环境中安装和运行 Quick Chart 服务的步骤，方便用户本地部署。
标准化 MCP 接口: 遵循 MCP 协议标准，易于与各种支持 MCP 协议的 LLM 客户端集成。

安装步骤

本 MCP 服务器可以通过 npm 安装，推荐使用 npm 进行安装，方便快捷。

方法一：使用 npm 安装 (推荐)

# 全局安装 (推荐用于 Cursor/Cline 等客户端)
npm install -g quick-chart-mcp

# 或者在你的项目中本地安装
npm install quick-chart-mcp

方法二：从源代码构建 (开发者选项)

如果您是开发者，希望从源代码构建和修改，可以参考仓库的 README.md 文件中的 "Build from Source" 部分。但对于普通用户，npm 安装方式已足够使用。

服务器配置

要让 MCP 客户端连接到 Quick Chart MCP Server，您需要在客户端中配置服务器信息。以下是一个典型的 MCP 服务器配置示例，请添加到您的 MCP 客户端配置文件中（例如 'mcp.json' 或客户端的服务器配置界面）。

{
  "mcpServers": {
    "quick-chart-mcp": {
      "autoApprove": [],
      "disabled": false,
      "timeout": 300,
      "command": "npx",  // 启动服务器的命令，这里使用 npx 来运行 npm 包
      "args": [
        "[email protected]" // 启动服务器的参数，指定要运行的 npm 包名和版本
      ],
      "transportType": "stdio" // 指定传输协议为 stdio，即标准输入输出
    }
  }
}

配置参数说明:

'server name': 'quick-chart-mcp' - 服务器的名称，用于在客户端中标识和引用。
'command': 'npx' - 用于启动服务器进程的命令。'npx' 允许您运行 npm 包的可执行文件，无需全局安装。
'args': '["[email protected]"]' - 传递给 'command' 的参数。这里指定了要运行的 npm 包 'quick-chart-mcp' 和版本 '1.0.13'。请注意，版本号可能会更新，请根据实际情况调整。
'transportType': 'stdio' - 指定 MCP 客户端与服务器之间使用标准输入输出流进行通信。

基本使用方法

安装 MCP 客户端: 确保您已经安装并配置了支持 MCP 协议的 LLM 客户端，例如 Cursor 或 Cline。
配置 MCP 服务器: 将上述提供的服务器配置信息添加到您的 MCP 客户端配置中，确保客户端能够找到并启动 Quick Chart MCP Server。
调用工具: 在 LLM 客户端中，您可以使用自然语言指令来调用 Quick Chart MCP Server 提供的工具。例如，您可以指示 LLM "使用 GetChartImgLink 工具生成一个柱状图" 并提供符合 Quick Chart API 规范的 JSON 参数。
获取图表: 服务器会处理 LLM 的请求，调用 Quick Chart API 生成图表，并将图表图片的链接返回给 LLM 客户端。LLM 可以进一步将链接展示给用户或用于其他用途。

示例工具调用:

GetChartImgLink: 用于生成图表图片链接。需要提供符合 Quick Chart API 格式的 JSON 参数作为输入。
InstallQuickChart: 用于获取在本地安装 Quick Chart Docker 服务的步骤。无需输入参数。

请参考仓库中 'src/actions/agent' 目录下的 action 定义文件，了解每个工具的具体参数和使用方法。

关键词