Plainsignal

PlainSignal Official MCP Server

javascript

2

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "plainsignal-plainsignal-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@plainsignal/plainsignal-mcp"
      ],
      "env": {
        "PLAINSIGNAL_TOKEN": "<YOUR_PLAINSIGNAL_TOKEN>"
      }
    }
  }
}

You run a dedicated MCP server to access PlainSignal analytics data. It exposes tools to fetch analytics reports and metrics through the MCP protocol, enabling you to query across organizations, domains, and time ranges with consistent, scriptable access.

How to use

You interact with the Plainsignal MCP server through a client that speaks the MCP protocol. Start by configuring the server to authenticate with your access token, then discover available tools and call them to retrieve analytics data.

How to install

Prerequisites: Node.js version 14 or newer, and a working npm installation.

Install the MCP server client globally so you can run it from anywhere on your system.

# Install globally
npm install -g @plainsignal/plainsignal-mcp

Or install locally in your project so you can run it via npx/your package.json scripts.

# Install in your project
npm install @plainsignal/plainsignal-mcp

# Run locally via npx
npx plainsignal-mcp --token <your_access_token>

You can also run with environment variables for convenience.

export PLAINSIGNAL_TOKEN=<your_access_token>
plainsignal-mcp

# Or start with a custom API base URL if needed
export PLAINSIGNAL_TOKEN=<your_access_token>
export API_BASE_URL=https://app.plainsignal.com/api/v1
plainsignal-mcp

Configuration and usage notes

Two common ways to run the server are available. If you prefer a local, self-contained instance, use the STDIO configuration to launch the MCP server as a separate process that your client talks to directly.

The following configuration demonstrates running the MCP server via a standard MCP launcher using npx and your access token.

Examples

Set your access token and start the MCP server via npx as shown above, or use the global CLI if you installed the package globally.

Available tools

getReport

Retrieves an analytics report for a specified organization, domain, and time period, returning aggregated metrics and insights.

getSubReport

Fetches detailed metrics for a specific aspect of analytics data, with optional pagination and filters to drill into page-level or entry-page metrics.