PlainSignal MCP Server

基本能力

产品定位

PlainSignal MCP Server 是一个用于处理和分析 PlainSignal 数据的服务器，通过 MCP 协议提供数据检索和报告生成功能。

核心功能

1. 数据报告检索：支持通过 getReport 和 getSubReport 工具获取特定域和时间段的分析报告。
2. 灵活配置：支持通过命令行参数、环境变量或配置文件自定义 API 基础 URL 和访问令牌。
3. 开发者友好：提供了示例客户端和资源示例，方便开发者快速上手和集成。

适用场景

1. 数据分析：适用于需要定期获取和分析 PlainSignal 数据的场景。
2. 报告生成：适用于生成特定时间段或特定域的分析报告。
3. 开发者集成：适用于开发者需要将 PlainSignal 数据集成到自己的应用中。

工具列表

1. getReport：检索指定域和时间段的分析报告。
2. 参数：organizationID, domainID, periodFrom, periodTo, periodSelection, aggregationWindow, filters
3. getSubReport：检索分析数据的详细指标。
4. 参数：organizationID, domainID, periodFrom, periodTo, periodSelection, aggregationWindow, subReportType, filters, pagination

常见问题解答

1. 如何安装：可以通过 npm 全局安装或本地安装，也可以从源代码构建。
2. 如何配置：可以通过命令行参数、环境变量或配置文件设置访问令牌和 API 基础 URL。
3. 如何调试：提供了示例客户端和资源示例，可以通过运行这些示例来测试和调试。

使用教程

使用依赖

1. 确保安装了 Node.js 14+ 版本，支持 ES 模块。

安装教程

通过 npm 安装（推荐）

# 全局安装
npm install -g @plainsignal/plainsignal-mcp

# 或本地安装
npm install @plainsignal/plainsignal-mcp

从源代码安装

1. 克隆仓库
2. 安装依赖

npm install

调试方式

通过 npm 安装后运行

# 全局安装后运行
plainsignal-mcp --token <your_access_token>

# 本地安装后运行
npx plainsignal-mcp --token <your_access_token>

# 使用环境变量
export PLAINSIGNAL_TOKEN=<your_access_token>
plainsignal-mcp

从源代码运行

node src/index.js --token <your_access_token>

# 使用环境变量
export PLAINSIGNAL_TOKEN=<your_access_token>
node src/index.js

运行示例客户端

export PLAINSIGNAL_TOKEN=your_access_token
npm run example

# 或运行资源示例
export PLAINSIGNAL_TOKEN=your_access_token
npm run resources-example

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。