Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hackle-io/hackle-mcp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Hackle MCP Server
A Model Context Protocol server for Hackle API providing tools and resources for querying A/B Test data.
Features
Tools
Experiment List Tool
- Name:
experiment-list - Description: Fetches a paginated list of A/B test experiments with search functionality.
- Parameters:
pageNumber: Page number (default: 1)pageSize: Number of items per page (default: 100)searchKeyword: Search keyword (optional)
Experiment Detail Tool
- Name:
experiment-detail - Description: Retrieves detailed information for a specific A/B test experiment.
- Parameters:
experimentId: Experiment ID
In-App Message List Tool
- Name:
in-app-message-list - Description: Fetches a paginated list of in-app messages with search functionality.
- Parameters:
pageNumber: Page number (default: 1)pageSize: Number of items per page (default: 100)searchKeyword: Search keyword (optional)
In-App Message Detail Tool
- Name:
in-app-message-detail - Description: Retrieves detailed information for a specific in-app message.
- Parameters:
inAppMessageId: In-app message ID
Push Message List Tool
- Name:
push-message-list - Description: Fetches a paginated list of push messages with search functionality.
- Parameters:
pageNumber: Page number (default: 1)pageSize: Number of items per page (default: 100)searchKeyword: Search keyword (optional)
Push Message Detail Tool
- Name:
push-message-detail - Description: Retrieves detailed information for a specific push message.
- Parameters:
pushMessageId: Push message ID
Active User Series Tool
- Name:
active-user-series - Description: Retrieves time-series data of active users. Available in daily, weekly, and monthly units.
- Parameters:
unit: Time unit (DAY, WEEK, MONTH) (default: DAY)date: Date (optional)
Retention Series Tool
- Name:
retention-series - Description: Retrieves time-series data of user retention. Available in daily, weekly, and monthly units.
- Parameters:
unit: Time unit (DAY, WEEK, MONTH) (default: DAY)date: Date (optional)
Stickiness Series Tool
- Name:
stickiness-series - Description: Retrieves time-series data of user stickiness (return visit frequency). Available in weekly and monthly units.
- Parameters:
unit: Time unit (WEEK, MONTH) (default: WEEK)date: Date (optional)
Data Report List Tool
- Name:
data-report-list - Description: Retrieves all data report metadata.
Data Report Detail Tool
- Name:
data-report-detail - Description: Retrieves single data report's detail. It will provide analytics chart id and type inside data report. It is recommended to use Analytics Chart Detail Tool to get further information of each chart.
- Parameters:
dataReportId: Data report's id. This can be found in response of Data Report List Tool.
Analytics Chart List Tool
- Name:
analytics-chart-list - Description: Retrieves data analytics chart's metadata list.
- Parameters:
pageNumber: Page number (default: 1) (optional)pageSize: Number of items per page (default: 100) (optional)searchKeyword: Search keyword (optional) (optional)chartType: Chart types that Hackle provides: FUNNEL, DATA_INSIGHT, RETENTION, and USER_PATH. (optional)
Analytics Chart Detail Tool
- Name:
analytics-chart-detail - Description: Retrieves data analytics chart's detail. You can visualize the chart using this tool's result.
- Parameters:
chartId: Analytics chart's id. It can be found in the response of Data Report Detail Tool or Analytics Chart List Tool.chartType: Analytics chart's type(FUNNEL, DATA_INSIGHT, RETENTION, USER_PATH). It can be found in the response of Data Report Detail Tool or Analytics Chart List Tool.
Installation
Add this entry to your claude_desktop_config.json:
- On Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
- On Windows: %APPDATA%\Claude\claude_desktop_config.json
- On Linux: ~/.config/Claude/claude_desktop_config.json
{
"mcpServers": {
"hackle-mcp": {
"command": "npx",
"args": ["-y", "@hackle-io/hackle-mcp@latest"],
"env": {
"API_KEY": "YOUR_API_KEY"
}
}
}
}Restart Claude if running
Getting Your API Key
To use the Hackle MCP Server, you will need an API key. To obtain your API key:
- Contact the Hackle team directly through Hackle Slack Community
- Request an API key for MCP Server access
- The Hackle team will provide you with a unique API key
Important: Never share your API key or commit it to public repositories. Treat your API key as a sensitive credential.
License
MIT