Plainsignal MCP

🚀 PlainSignal MCP 服務器

PlainSignal MCP 服務器是基於 Model Context Protocol (MCP) 實現的數據分析工具，藉助 MCP 協議，用戶能夠輕鬆檢索分析報告與指標。

🚀 快速開始

PlainSignal MCP 服務器可通過 npm 或源代碼進行安裝，安裝完成後，你可以根據需求指定訪問令牌或 API 基礎 URL 來啟動服務器。

📦 安裝指南

從 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 <api_base_url>

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

設置訪問令牌和 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": "<YOUR_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 文件以獲取詳細信息。