Plainsignal Mcp

🚀 PlainSignal MCP 服务器

PlainSignal MCP 服务器是基于 Model Context Protocol (MCP) 的实现，专为分析数据而设计。借助 MCP 协议，它能够帮助用户便捷地检索分析报告和各项指标。

🚀 快速开始

要使用 PlainSignal MCP 服务器，你需要先完成安装步骤，之后就能根据自己的需求运行服务器并进行相关操作。

📦 安装指南

从 npm（推荐）

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

# 或者在项目中本地安装
npm install @plainsignal/plainsignal-mcp

从源代码

1. 克隆此仓库
2. 安装依赖项：

npm install

⚠️ 重要提示

该项目使用 ES 模块而不是 CommonJS。请确保你使用的是支持 ES 模块的 Node.js 版本（Node.js 14+）。

💻 使用示例

基础用法

当从 npm 安装时

# 如果全局安装
plainsignal-mcp --token <你的访问令牌>

# 如果在项目中本地安装
npx plainsignal-mcp --token <你的访问令牌>

# 或者使用环境变量
export PLAINSIGNAL_TOKEN=<你的访问令牌>
plainsignal-mcp

当从源代码使用时

node src/index.js --token <你的访问令牌>

# 或者使用环境变量
export PLAINSIGNAL_TOKEN=<你的访问令牌>
node src/index.js

高级用法

指定自定义的 API 基础 URL

node src/index.js --token <你的访问令牌> --api-base-url 

# 或者使用短格式
node src/index.js -t <你的访问令牌> -u 

设置访问令牌和 API 基础 URL 作为环境变量并运行测试脚本

export PLAINSIGNAL_TOKEN=your_access_token
export API_BASE_URL=https://app.plainsignal.com/api/v1
./test.sh

⚠️ 重要提示

默认情况下，服务器连接到 https://app.plainsignal.com/api/v1。

📚 详细文档

MCP 服务器配置

Claude Desktop

在你的 claude_desktop_config.json 中添加以下代码片段：

{
"mcpServers": {
"plainsignal": {
"command": "npx -y @plainsignal/plainsignal-mcp",
"env": {
"PLAINSIGNAL_TOKEN": ""
}
}
}
}

可用工具

getReport

用于检索指定域和时间段的分析报告。

getDomains

列出所有已配置的域名。

安装和使用示例

示例 1：基本安装和使用

# 全局安装 MCP 服务器
npm install -g @plainsignal/plainsignal-mcp

# 运行服务器并连接到 PlainSignal 分析服务
node src/index.js --token your_api_token

示例 2：自定义配置

# 安装 MCP 服务器
npm install @plainsignal/plainsignal-mcp

# 创建配置文件
echo '{
"apiToken": "your_api_token",
"baseUrl": "https://app.plainsignal.com/api/v1"
}' > config.json

# 运行服务器
node src/index.js --config config.json

📄 许可证

该项目在 MIT 许可证下发布——查看 LICENSE 文件以获取详细信息。