Model Context Protocol server enabling retrieval of detailed analytics reports and metrics through configurable API endpoints, supporting customizable time periods, filters, and data aggregation for advanced analytics insights.
Unlock the full potential of PlainSignal MCP Server through LangDB's AI Gateway. Get enterprise-grade security, analytics, and seamless integration with zero configuration.
Free tier available • No credit card required
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.
# Install globally npm install -g @plainsignal/plainsignal-mcp # Or install locally in your project npm install @plainsignal/plainsignal-mcp
npm install
This project uses ES modules instead of CommonJS. Make sure you're using a Node.js version that supports ES modules (Node.js 14+).
# If installed globally plainsignal-mcp --token # If installed locally npx plainsignal-mcp --token # Or using an environment variable export PLAINSIGNAL_TOKEN= plainsignal-mcp
Run the server with your access token:
node src/index.js --token # Or using an environment variable export PLAINSIGNAL_TOKEN= node src/index.js
You can also specify a custom API base URL:
node src/index.js --token --api-base-url
Or use the short format:
node src/index.js -t -u
Alternatively, set the access token and API base URL as environment variables and use the test script:
export PLAINSIGNAL_TOKEN=your_access_token export API_BASE_URL=https://app.plainsignal.com/api/v1 ./test.sh
By default, the server connects to https://app.plainsignal.com/api/v1
.
Add this snippet to your claude_desktop_config.json
:
{
"mcpServers": {
"plainsignal": {
"command": "npx -y @plainsignal/plainsignal-mcp",
"env": {
"PLAINSIGNAL_TOKEN": ""
}
}
}
}
The server provides the following tools:
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 pairsRetrieves 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 offsetThis 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:
node src/index.js --token --api-base-url https://app.plainsignal.com/api/v1
Set the API_BASE_URL
environment variable:
export API_BASE_URL=https://app.plainsignal.com/api/v1
Pass a custom API base URL to the constructor when instantiating the server programmatically:
const server = new PlainSignalStdioServer(token, 'https://app.plainsignal.com/api/v1');
The server is implemented using the MCP SDK and communicates over STDIO.
An example client is provided to demonstrate how to use the MCP server:
# Set your access token export PLAINSIGNAL_TOKEN=your_access_token # Run the example client npm run example
Or run the resources example client:
# Set your access token export PLAINSIGNAL_TOKEN=your_access_token # Run the resources example client npm run resources-example
The example client demonstrates:
getReport
tool with sample parametersThe resources example client demonstrates:
listDomains
resourceThis project is licensed under the MIT License - see the LICENSE file for details.
Discover shared experiences
Shared threads will appear here, showcasing real-world applications and insights from the community. Check back soon for updates!