PlainSignal MCP Server
This is a Model Context Protocol (MCP) server implementation for PlainSignal analytics data. It provides tools for retrieving analytics reports and metrics through the MCP protocol.
Setup
Installation
From npm (recommended)
From source
- Clone this repository
- Install dependencies:
This project uses ES modules instead of CommonJS. Make sure you're using a Node.js version that supports ES modules (Node.js 14+).
Usage
When installed from npm
When using from source
Run the server with your access token:
You can also specify a custom API base URL:
Or use the short format:
Alternatively, set the access token and API base URL as environment variables and use the test script:
By default, the server connects to https://app.plainsignal.com/api/v1
.
MCP Server configs
Claude Desktop
Add this snippet to your claude_desktop_config.json
:
Available Tools
The server provides the following tools:
getReport
Retrieves an analytics report for a specified domain and time period.
Parameters:
organizationID
: Organization IDdomainID
: Domain IDperiodFrom
: Report start datetime in RFC3339 formatperiodTo
: Report end datetime in RFC3339 formatperiodSelection
: Period type (m: month, y: year, d: day)aggregationWindow
: Data aggregation window (h: hour, d: day)filters
: (Optional) List of filters as key-value pairs
getSubReport
Retrieves detailed metrics for a specific aspect of analytics data.
Parameters:
organizationID
: Organization IDdomainID
: Domain IDperiodFrom
: Report start datetime in RFC3339 formatperiodTo
: Report end datetime in RFC3339 formatperiodSelection
: Period type (m: month, y: year, d: day)aggregationWindow
: Data aggregation window (h: hour, d: day)subReportType
: Type of report (1: page, 2: entry page, etc.)filters
: (Optional) List of filters as key-values pairspagination
: (Optional) Pagination controls with limit and offset
API Reference
This server communicates with the PlainSignal API. By default, it connects to https://app.plainsignal.com/api/v1
, but you can configure the API endpoint in several ways:
- Use the
--api-base-url
command line option: - Set the
API_BASE_URL
environment variable: - Pass a custom API base URL to the constructor when instantiating the server programmatically:
For Developers
The server is implemented using the MCP SDK and communicates over STDIO.
Examples
An example client is provided to demonstrate how to use the MCP server:
Or run the resources example client:
The example client demonstrates:
- Connecting to the MCP server
- Listing available tools
- Calling the
getReport
tool with sample parameters - Processing and displaying the results
The resources example client demonstrates:
- Connecting to the MCP server
- Listing available resources
- Reading the
listDomains
resource - Processing and displaying the results
License
This project is licensed under the MIT License - see the LICENSE file for details.
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Provides tools for retrieving analytics reports and metrics from PlainSignal through the Model Context Protocol (MCP).
Related MCP Servers
- -securityAlicense-qualityA tool for Model Context Protocol (MCP) that allows you to analyze web content and add it to your knowledge base, storing content as Markdown files for easy viewing with tools like Obsidian.Last updated -9PythonMIT License
- -securityFlicense-qualityProvides an interface to access Google Analytics Data API through Model Context Protocol (MCP), allowing users to retrieve reports and realtime data from Google Analytics 4 properties.Last updated -1317JavaScript
- AsecurityAlicenseAqualityA Model Context Protocol server that connects to AppSignal, allowing users to fetch, list, and analyze incident information from their AppSignal monitoring.Last updated -312TypeScriptMIT License
- AsecurityAlicenseAqualityA Model Context Protocol server that lets you fetch Microsoft Clarity analytics data through Claude for Desktop or other MCP-compatible clients, with support for filtering by dimensions and retrieving various metrics.Last updated -153924TypeScriptMIT License