PlainSignal MCP Server: Frequently Asked Questions

Q: What is the PlainSignal MCP Server? A: The PlainSignal MCP Server is an implementation of the Model Context Protocol (MCP) that provides tools for retrieving analytics reports and metrics from PlainSignal analytics data. It allows AI models to access and interact with this data.

Q: What is MCP (Model Context Protocol)? A: MCP is an open protocol that standardizes how applications provide context to Large Language Models (LLMs).

Q: How do I install the PlainSignal MCP Server? A: You can install it globally or locally using npm with the command npm install -g @plainsignal/plainsignal-mcp (global) or npm install @plainsignal/plainsignal-mcp (local).

Q: How do I run the server after installation? A: After installing, run the server using the command plainsignal-mcp --token <your_access_token> (global) or npx plainsignal-mcp --token <your_access_token> (local). You can also use the PLAINSIGNAL_TOKEN environment variable.

Q: What is the purpose of the access token? A: The access token is used to authenticate your requests to the PlainSignal API, allowing the server to retrieve your analytics data securely.

Q: Can I specify a custom API base URL? A: Yes, you can specify a custom API base URL using the --api-base-url option when running the server or by setting the API_BASE_URL environment variable.

Q: What tools are available in the PlainSignal MCP Server? A: The server provides the getReport and getSubReport tools for retrieving analytics reports and metrics.

Q: What does the getReport tool do? A: The getReport tool retrieves an analytics report for a specified organization, domain, and time period.

Q: What does the getSubReport tool do? A: The getSubReport tool retrieves detailed metrics for a specific aspect of analytics data, such as page views or entry pages.

Q: What parameters are required for the getReport and getSubReport tools? A: Both tools require parameters such as organizationID, domainID, periodFrom, periodTo, periodSelection, and aggregationWindow. They also accept optional filters.

Q: How can I integrate the PlainSignal MCP Server with Claude Desktop? A: Add the provided configuration snippet to your claude_desktop_config.json file, including your PlainSignal token.

Q: Where does the server connect to by default? A: By default, the server connects to https://app.plainsignal.com/api/v1.

Q: Is there an example client available to demonstrate how to use the server? A: Yes, example clients (npm run example and npm run resources-example) are provided to demonstrate how to connect to the server, list available tools/resources, and call the getReport tool with sample parameters.

Q: What is the license for this project? A: This project is licensed under the MIT License.

Q: How does the PlainSignal MCP Server integrate with UBOS? A: Integrating the PlainSignal MCP Server with UBOS allows you to seamlessly incorporate analytics-driven insights into your AI agents’ decision-making processes. UBOS’s orchestration capabilities manage complex workflows and connect the MCP server with other enterprise data sources.

Q: What are some use cases for the PlainSignal MCP Server in conjunction with UBOS? A: Use cases include AI-powered marketing analysis, automated website optimization, intelligent customer support, and proactive security monitoring.

Q: What if I encounter issues during installation or usage? A: Consult the documentation for troubleshooting steps, or reach out to the support channels for the PlainSignal MCP Server for assistance.