Plainsignal MCP

🚀 PlainSignal MCP Server

This is an implementation of the Model Context Protocol (MCP) server for PlainSignal to analyze data. It provides tools to retrieve analysis reports and metrics via the MCP protocol.

🚀 Quick Start

This README will guide you through the installation, configuration, and usage of the PlainSignal MCP Server.

✨ Features

• Retrieve analysis reports and metrics through the MCP protocol.
• Support installation from npm or source code.
• Provide multiple ways to specify access tokens and API base URLs.
• Offer configuration examples for Claude Desktop.
• Provide useful tools such as getReport and getDomains.

📦 Installation

From npm (Recommended)

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

# Or install locally in your project
npm install @plainsignal/plainsignal-mcp

From Source Code

1. Clone this repository.
2. Install dependencies:

npm install

⚠️ Important Note

This project uses ES modules instead of CommonJS. Make sure you are using a Node.js version that supports ES modules (Node.js 14+).

💻 Usage Examples

When Installed from npm

# If installed globally
plainsignal-mcp --token <your_access_token>

# If installed locally in your project
npx plainsignal-mcp --token <your_access_token>

# Or use environment variables
export PLAINSIGNAL_TOKEN=<your_access_token>
plainsignal-mcp

When Using from Source Code

Run the server and specify your access token:

node src/index.js --token <your_access_token>

# Or use environment variables
export PLAINSIGNAL_TOKEN=<your_access_token>
node src/index.js

You can also specify a custom API base URL:

node src/index.js --token <your_access_token> --api-base-url <api_base_url>

# Or use the short format
node src/index.js -t <your_access_token> -u <api_base_url>

Or set the access token and API base URL as environment variables and run the test script:

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

💡 Usage Tip

By default, the server connects to https://app.plainsignal.com/api/v1.

📚 Documentation

MCP Server Configuration

Claude Desktop

Add the following code snippet to your claude_desktop_config.json:

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

Available Tools

The server provides the following tools:

getReport

Retrieve an analysis report for a specified domain and time period.

getDomains

List all configured domains.

Installation and Usage Examples

Example 1: Basic Installation and Usage

# Install the MCP server globally
npm install -g @plainsignal/plainsignal-mcp

# Run the server and connect to the PlainSignal analysis service
node src/index.js --token your_api_token

Example 2: Custom Configuration

# Install the MCP server
npm install @plainsignal/plainsignal-mcp

# Create a configuration file
echo '{
  "apiToken": "your_api_token",
  "baseUrl": "https://app.plainsignal.com/api/v1"
}' > config.json

# Run the server
node src/index.js --config config.json

📄 License

This project is released under the MIT License - see the LICENSE file for details.