使用说明

项目简介

Matomo MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器实现，旨在连接 AI Agent (如大型语言模型) 与 Matomo Analytics 分析平台。该项目通过 MCP 协议，将 Matomo Reporting API 的功能封装为标准化的 工具 (Tools)，使 AI Agent 能够安全、便捷地访问和利用 Matomo 强大的网站分析数据。

主要功能点

资源 (Resources) 管理: 虽然仓库描述中没有明确提及资源管理，但 MCP 服务器的核心是提供上下文信息，Matomo Analytics 的数据可以被视为一种资源，服务器负责数据的安全访问。
工具 (Tools) 注册和执行: 该服务器将 Matomo Reporting API 的各种分析功能（如站点管理、标签管理、访问数据查询等）作为 MCP 工具注册，供 LLM 客户端调用，例如：
- 站点管理 (SitesManager)
- 标签管理 (TagManager)
- 用户ID (UserId)
- …以及更多 Matomo API 模块 (逐步完善中)
Prompt 模板 (Prompts): 仓库信息中没有明确提及 Prompt 模板功能，但作为 MCP 服务器，理论上可以支持 Prompt 模板的定义和渲染，以便 LLM 客户端进行定制化的交互。

安装步骤

确保已安装 Node.js: 推荐 Node.js v18 或更高版本。

安装 MCP Server 包:

npm install @mj-kiwi/matomo-mcp-server

服务器配置

MCP 服务器主要通过环境变量进行配置。以下是一个 MCP 客户端 'server' 配置示例 (JSON 格式):

{
  "serverName": "matomo-mcp-server",
  "command": "node",
  "args": [
    "packages/matomo-mcp-server/dist/index.js"
  ],
  "env": {
    // Matomo 实例的 URL (必填)
    "MATOMO_URL": "https://your-matomo-instance.com",
    // Matomo API Token (必填)
    "MATOMO_TOKEN_AUTH": "your-api-token",
    // (可选) 默认站点 ID，如果客户端不指定 idSite 参数，则使用此默认值
    // "MATOMO_DEFAULT_SITE_ID": "1"
  }
}

配置参数说明:

'serverName': MCP 服务器的名称，客户端用于识别和连接。
'command': 启动 MCP 服务器的命令，通常为 'node'。
'args': 启动命令的参数，指向 MCP 服务器的入口文件，根据实际安装路径调整。
'env': 环境变量配置，包含：
- 'MATOMO_URL': 必填。您的 Matomo 分析平台的 URL 地址。
- 'MATOMO_TOKEN_AUTH': 必填。用于 API 鉴权的 Matomo Token。
- 'MATOMO_DEFAULT_SITE_ID': 可选。设置默认的 Matomo 站点 ID，方便在不指定站点 ID 的情况下访问数据。

请注意: 启动 MCP 服务器前，请确保已根据您的 Matomo 实例信息配置好环境变量。您可能需要先构建项目 ('npm run build') 以生成 'dist/index.js' 文件。

基本使用方法

启动 MCP 服务器: 根据上述配置，使用 MCP 客户端配置的启动命令启动 Matomo MCP Server。
MCP 客户端请求: LLM 客户端可以通过 JSON-RPC 协议与 MCP 服务器通信，调用已注册的 Matomo API 工具，例如：
- 调用 'SitesManager.getAllSites' 工具获取所有站点信息。
- 调用 'VisitsSummary.get' 工具获取访问量统计数据。
- 更多工具请参考 Matomo Reporting API 文档和 '@mj-kiwi/matomo-mcp-server' 包的实现。
数据交互: MCP 服务器接收客户端请求，调用 Matomo Reporting API 获取数据，并将结果以 JSON-RPC 响应返回给客户端。

提示: 由于该项目仍在积极开发中，目前只实现了部分 Matomo API 模块，更多功能敬请期待后续更新。

关键词