Plausible Analytics MCP Server 使用说明

项目简介

Plausible Analytics MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它充当大型语言模型 (LLM) 与 Plausible Analytics 网站分析平台之间的桥梁。通过此服务器,LLM 客户端可以利用 MCP 协议标准化的方式,安全地查询和获取 Plausible Analytics 中存储的网站数据,从而实现更智能的数据分析和报告生成。

主要功能点

  • Plausible Analytics 数据查询: 提供 'plausible_query' 工具,允许 LLM 客户端查询网站的各项关键指标,例如访客数量、页面浏览量、跳出率、访问时长等。
  • 标准化 MCP 协议: 遵循 MCP 协议标准,确保与支持 MCP 协议的 LLM 客户端(如 Claude 桌面应用)无缝集成。
  • 灵活的数据查询: 支持自定义查询指标和时间范围,满足多样化的数据分析需求。
  • 易于集成和部署: 基于 Node.js 开发,易于安装和配置,可通过标准输入/输出 (stdio) 与 MCP 客户端通信。

安装步骤

  1. 环境准备: 确保您的机器上已安装 Node.js 和 npm (Node.js 包管理器)。
  2. 下载代码: 使用 Git 克隆仓库到本地:
    git clone https://github.com/AVIMBU/plausible-mcp-server.git
  3. 进入项目目录: 导航到项目文件夹:
    cd plausible-mcp-server
  4. 安装依赖: 使用 npm 安装项目所需的依赖包:
    npm install
  5. 构建项目: 编译 TypeScript 代码生成可执行的 JavaScript 文件:
    npm run build
    构建完成后,将在项目根目录下生成 'dist' 文件夹,其中包含编译后的服务器代码 'index.js'。

服务器配置

要将 Plausible Analytics MCP Server 集成到 MCP 客户端(例如 Claude 桌面应用)中,您需要配置客户端以连接到此服务器。以下是在 MCP 客户端配置文件中添加服务器配置的示例(JSON 格式)。请根据您的实际情况修改 'args' 中的路径,将 '/path/to/project/dist/index.js' 替换为 'dist/index.js' 文件在您本地文件系统中的绝对路径。

{
  "mcpServers": {
    "plausible-analytics": {
      "command": "node",
      "args": ["/path/to/project/dist/index.js"],
      "env": {
        "PLAUSIBLE_API_URL": "https://plausible.io/api/v2",
        "PLAUSIBLE_API_KEY": "YOUR_PLAUSIBLE_API_KEY"
      }
    }
  }
}

配置参数说明:

  • '"plausible-analytics"': 服务器名称,您可以自定义,用于在 MCP 客户端中标识此服务器。
  • '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件。
  • '"args": ["/path/to/project/dist/index.js"]': 启动命令的参数,指向编译后的服务器入口文件 'dist/index.js' 的路径。请务必替换为实际路径
  • '"env"': 环境变量配置。
    • '"PLAUSIBLE_API_URL": "https://plausible.io/api/v2"': Plausible Analytics API 的 URL,通常无需修改。
    • '"PLAUSIBLE_API_KEY": "YOUR_PLAUSIBLE_API_KEY"': 您的 Plausible Analytics API 密钥。您需要在 Plausible Analytics 仪表板中创建 API 密钥,并将其替换为 '"YOUR_PLAUSIBLE_API_KEY"'。

基本使用方法

完成服务器配置后,在 MCP 客户端中,您可以使用自然语言指令指示 LLM 调用 'plausible_query' 工具来查询 Plausible Analytics 数据。例如,在 Claude 桌面应用中,您可以尝试以下指令:

  • "Can you provide a daily overview of my website analytics from Plausible for my domain example.com?"
  • "Generate a report of website traffic for example.com for the last 7 days using Plausible."
  • "使用 Plausible 查询 example.com 网站过去30天的访客数量和页面浏览量。"

LLM 客户端会将这些自然语言指令转换为对 'plausible_query' 工具的调用,并将查询参数(例如网站域名、指标、时间范围)传递给 Plausible Analytics MCP Server。服务器会执行查询并将结果返回给 LLM 客户端,最终以自然语言形式呈现给用户。

请确保您已配置正确的 Plausible API 密钥和网站域名,以便服务器能够成功连接到 Plausible Analytics 并获取数据。

信息

分类

数据库与文件